Kevin Pfeifer
ea86e49e9b
update contributing guide
|
3 years ago | |
|---|---|---|
| .github | 3 years ago | |
| config | 4 years ago | |
| contrib | 7 years ago | |
| src | 3 years ago | |
| templates | 4 years ago | |
| tests | 3 years ago | |
| .editorconfig | 5 years ago | |
| .gitattributes | 5 years ago | |
| .gitignore | 5 years ago | |
| .mailmap | 6 years ago | |
| .stickler.yml | 6 years ago | |
| LICENSE | 7 years ago | |
| Makefile | 4 years ago | |
| README.md | 4 years ago | |
| VERSION.txt | 3 years ago | |
| composer.json | 3 years ago | |
| phpcs.xml | 5 years ago | |
| phpstan-baseline.neon | 3 years ago | |
| phpstan.neon | 4 years ago | |
| phpunit.xml.dist | 4 years ago | |
| psalm-baseline.xml | 3 years ago | |
| psalm.xml | 4 years ago |
README.md
CakePHP is a rapid development framework for PHP which uses commonly known design patterns like Associative Data Mapping, Front Controller, and MVC. Our primary goal is to provide a structured framework that enables PHP users at all levels to rapidly develop robust web applications, without any loss to flexibility.
Installing CakePHP via Composer
You can install CakePHP into your project using Composer. If you're starting a new project, we recommend using the app skeleton as a starting point. For existing applications you can run the following:
$ composer require cakephp/cakephp
For details on the (minimum/maximum) PHP version see version map.
Running Tests
Assuming you have PHPUnit installed system wide using one of the methods stated here, you can run the tests for CakePHP by doing the following:
- Copy
phpunit.xml.disttophpunit.xml. - Add the relevant database credentials to your
phpunit.xmlif you want to run tests against a non-SQLite datasource. - Run
phpunit.
Some Handy Links
- CakePHP - The rapid development PHP framework.
- CookBook - The CakePHP user documentation; start learning here!
- API - A reference to CakePHP's classes.
- Awesome CakePHP - A list of featured resources around the framework.
- Plugins - A repository of extensions to the framework.
- The Bakery - Tips, tutorials and articles.
- Community Center - A source for everything community related.
- Training - Join a live session and get skilled with the framework.
- CakeFest - Don't miss our annual CakePHP conference.
- Cake Software Foundation - Promoting development related to CakePHP.
Get Support!
- Slack - Join us on Slack.
- Discord - Join us on Discord.
- #cakephp on irc.freenode.net - Come chat with us, we have cake.
- Forum - Official CakePHP forum.
- GitHub Issues - Got issues? Please tell us!
- Roadmaps - Want to contribute? Get involved!
Contributing
- CONTRIBUTING.md - Quick pointers for contributing to the CakePHP project.
- CookBook "Contributing" Section - Details about contributing to the project.
Security
If you’ve found a security issue in CakePHP, please use the procedure described in SECURITY.md.