codefyphp / skeleton
Skeleton package for creating a new CodefyPHP Framework project.
Installs: 7
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 0
Forks: 0
Open Issues: 0
Type:project
Requires
- php: >=8.2
- codefyphp/codefy: ^2
- franzl/whoops-middleware: ^2.0
- paragonie/csp-builder: ^2.9
Requires (Dev)
- pestphp/pest: ^1.23
- qubus/qubus-coding-standard: ^1.1
Suggests
- fenom/fenom: Lightweight and fast template engine for PHP.
- fenom/providers-collection: Additional providers for Fenom template engine.
- foil/foil: Write simple, clean, and concise templates with nothing more than PHP.
README
This repository contains the skeleton package for creating a new CodefyPHP project. If you are only interested in the core framework, visit the main CodefyPHP Framework repository.
CodefyPHP is not a framework such as the likes of Symfony, Laravel, Codeigniter or CakePHP. Codefy is a simple, light framework providing interfaces and implementations for architecting a Domain Driven project with CQRS, Event Sourcing and implementations of PSR-3, PSR-6, PSR-7, PSR-11, PSR-12, PSR-15, PSR-16 and PSR-17.
The philosophy of Codefy is that code should be systematized, maintainable, and follow OOP (Object-Oriented Programming). CodefyPHP tries not to be too opinionated, yet encourages best practices and coding standards by following Qubus Coding Standards. Use Codefy as you see fit. You can tap into all, some or none of the features and instead use the interfaces to build your own implementations for a domain driven project.
📍 Requirement
- PHP 8.2+
- Additional constraints based on which components are used.
🏆 Highlighted Features
- A powerful routing engine
- Robust dependency injector for bootstrapping
- Adapters for cookies, sessions and cache storage
- Provides a simple hook and event system without affecting core code
- Encourages object-oriented programming
- Multiple PSR implementations
- Dual query builders with migrations
- Scheduler for scheduling tasks/jobs
- Security and sanitizing helpers
- Dual templating engines
- NIST Level 2 Standard Role-Based Access Control
📦 Installation
To create a new project, run the following command:
composer create-project codefyphp/skeleton my-app-name
Replace my-app-name with the directory name to which you are starting your new project. Once installed, cd into
the root directory of your app and start the development server by running the following terminal command:
php codex serve
Once the server starts, visit the new install at http://localhost:8080.
🕑 Releases
📘 Documentation
Documentation is still a work in progress. Between the Qubus Components documentation and CodefyPHP's documentation, that should help you get started. If you have questions or need help, feel free to ask for help in the forums.
🙌 Sponsors
If you use CodefyPHP or you are interested in supporting the continued development of my opensource projects, please consider sponsoring me via Github.
🖋 Contributing
CodefyPHP could always be better! If you are interested in contributing enhancements or bug fixes, here are a few rules to follow in order to ease code reviews, and discussions before I accept and merge your work.
- You MUST follow the QubusPHP Coding Standards.
- You MUST write (or update) unit tests.
- You SHOULD write documentation.
- Please, write commit messages that make sense, and rebase your branch before submitting your Pull Request.
- Please squash your commits too.
This is used to "clean" your Pull Request before merging it (I don't want commits such as
fix tests,fix 2,fix 3, etc.).
🔐 Security Vulnerabilities
If you discover a vulnerability in the code, please email joshua@joshuaparker.dev.
📄 License
CodefyPHP is opensource software licensed under the MIT License.