This is a template for the new CakePHP projects.
Developed by Qobo, used in Qobrix.
There are two ways to install and start using this project template.
You can create a new project from this template using composer.
composer create-project qobo/project-template-cakephp example.com
cd example.com
git init
git add .
git commit -m "Initial commit"
./bin/build app:install DB_NAME=my_app,PROJECT_NAME="My Project",PROJECT_VERSION="v1.0.0"Alternatively, you can start using this project by cloning the git repository and changing remote origin.
git clone https://github.com/QoboLtd/project-template-cakephp.git example.com
cd example.com
./bin/build app:install DB_NAME=my_app,PROJECT_NAME="My Project",PROJECT_VERSION="v1.0.0"
git remote remove origin
git remote add origin git@github.com:YOUR-VENDOR/YOUR-REPOSITORY.git
git push origin masterWhen you want to update your project with the latest and greatest project-template-cakephp, do the following:
cd exmample.com
git pull https://github.com/QoboLtd/project-template-cakephp
The above will only work if you installed it via the git clone. For composer
project installations you might need to add --allow-unrelated-histories
parameter.
Now that you have the project template installed, check that it works before you start working on your changes. Fire up the PHP web server:
./bin/phpserv
Or run it on the alternative port:
./bin/phpserv -H localhost -p 9000
In your browser navigate to http://localhost:8000.
You should see the standard phpinfo() page. If you do, all parts
are in place.
Now you can develop your PHP project as per usual, but with the following advantages:
- Support for PHP built-in web server
- Per-environment configuration using
.envfile, which is ignored by git - Powerful build system (Robo) integrated
- Composer integrated with
vendor/folder added to.gitignore. - PHPUnit integrated with
tests/folder and example unit tests. - Sensible defaults for best practices - favicon.ico, robots.txt, MySQL dump, Nginx configuration, GPL, etc.
For example, you can easily automate the build process of your application
by modifying the included Robo files in build/ folder. Run the following
command to examine available targets:
./bin/build
As you can see, there are already some placeholders for your application's build process. By default, it is suggested that you have these:
app:install- for installation process of your application,app:update- for the update process of the already installed application, andapp:remove- for the application removal process and cleanup.
You can, of course, add your own, remove these, or change them any way you want. Have a look at Robo documentation for more information on how to use these targets and pass runtime configuration parameters.
project-template-cakephp brings quite a bit of setup for testing your projects. The first part of this setup is PHPUnit. To try it out, runt the following command (don't worry if it fails, we'll get to it shortly):
./vendor/bin/phpunit
If it didn't work for you, here are some of the things to try:
- If
phpunitcommand wasn't found, trycomposer installand then run the command again. Chances are phpunit was removed during theapp:install, which runs composer with--no-devparameter. - If you had some other issue, please let us know.
Continious Integration is a tool that helps to run your tests whenever you do any changes on your code base (commit, merge, etc). There are many tools that you can use, but project-template-cakephp provides an example integration with Travis CI.
Have a look at .travis.yml file, which describes the environment matrix, project installation
steps and ways to run the test suite. For your real project, based on project-template-cakephp, you'd probably
want to remove the example tests from the file.
project-template-cakephp provides a few examples of how to write and organize unit tests. Have a look
in the tests/ folder. Now you have NO EXCUSE for not testing your applications!
Running this project template with MySQL 5.7 or MariaDB 10 sometimes causes fatal errors with SQL queries. We are looking for better ways to catch and fix those, but if you encounter them in your environment, please adjust your MySQL / MariaDB configuration for SQL mode.
SQL mode can be adjusted by either setting it in the etc/my.cnf file like so:
[mysqld]
sql-mode="NO_ZERO_IN_DATE,NO_ZERO_DATE"
Or, alternatively, via an SQL query, like so:
mysql > SET GLOBAL sql_mode=(SELECT REPLACE(@@sql_mode,'ONLY_FULL_GROUP_BY',''));
See this StackOverflow thread for more information.
Here are a few examples of the issues and how to fix them.
Error: SQLSTATE[22007]: Invalid datetime format: 1292 Incorrect datetime
value: '2017-11-30T13:30:48+02:00' for column 'timestamp' at row 1
If you encounter the above error (often seen on Fedora 27 or above), make sure your SQL mode includes "NO_ZERO_IN_DATE,NO_ZERO_DATE".
Error: SQLSTATE[42000]: Syntax error or access violation: 1055 Expression #1 of
SELECT list is not in GROUP BY clause and contains nonaggregated column ...
If you encounter the above error (often seen on Ubuntu 16.05), make sure your SQL mode DOES NOT include "ONLY_FULL_GROUP_BY".