Skip to content

Latest commit

 

History

History
86 lines (54 loc) · 3.94 KB

README.md

File metadata and controls

86 lines (54 loc) · 3.94 KB
Raw

CakePHP Framework

Software License Build Status Code Consistency Total Downloads

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:"~3.0"

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:

  1. Copy phpunit.xml.dist to phpunit.xml.
  2. Add the relevant database credentials to your phpunit.xml if you want to run tests against a non-SQLite datasource.
  3. Run phpunit.

Contributing

See CONTRIBUTING.md for more information.

Some Handy Links

CakePHP - The rapid development PHP framework.

CookBook - THE CakePHP user documentation; start learning here!

API - A reference to CakePHP's classes.

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!

#cakephp on irc.freenode.net - Come chat with us, we have cake.

Google Group - Community mailing list and 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 following procedure instead of the normal bug reporting system. Instead of using the bug tracker, mailing list or IRC please send an email to security [at] cakephp.org. Emails sent to this address go to the CakePHP core team on a private mailing list.

For each report, we try to first confirm the vulnerability. Once confirmed, the CakePHP team will take the following actions:

  • Acknowledge to the reporter that we’ve received the issue, and are working on a fix. We ask that the reporter keep the issue confidential until we announce it.
  • Get a fix/patch prepared.
  • Prepare a post describing the vulnerability, and the possible exploits.
  • Release new versions of all affected versions.
  • Prominently feature the problem in the release announcement.