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.dist
to phpunit.xml
.
- Add the relevant database credentials to your
phpunit.xml
if you want to run tests against
a non-SQLite datasource.
- Run
phpunit
.
Learn More
- CakePHP - The home of the CakePHP project.
- Book - The CakePHP documentation; start learning here!
- API - A reference to CakePHP's classes and API documentation.
- Awesome CakePHP - A curated list of featured resources around 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.