earthit/php-template-project

PHP Template Project

PHP Template Project Technical Documentation

This README was automatically generated by PHPProjectInitializer. If this paragraph is still present it probably means nobody's bothered to write any project-specific documentation, yet., _(*1)

See also:, _(*2)

• PHP Application Architecture
• Tutorials
  • Make a simple page
• Upgrading from the template project

Folder structure

• composer.json - PHP package and dependency information, used by Composer.
• package.json - Node package and dependency information, used by NPM.
• init-*.php - Scripts to initialize global state in PHP.
• src/db-migrations/ - Database scripts
  • upgrades/ - Upgrades to be run in order to build the schema
  • test-data/ - Run interleaved with upgrades for additional unit test data
  • miscellaneous handy scripts
• src/ - Source code for this project.
  • main/ - Primary application code, broken down by language
  • test/ - Unit tests
  • views/ - View templates
• build/ and/or target/ - Compiled stuff. Not checked in.
• node_modules/ - External node libraries, managed my NPM.
• vendor/ - External PHP libraries, managed by Composer.
• config/ - Deployment configuration.
• www/ - Serves as the 'document root' for your project. Contains files to be served directly and a .htaccess and bootstrap.php to handle paths that don't correspond to existing files.
• Vagrantfile - configuration file for Vagrant.
• vm-files/ - files to be imported into the vagrant Virtual machine.
• provision.sh - Virtual machine provisioning script.

Note that the src/<component>/<language> directory is a Maven convention. It's verbose, but gives enough information to keep projects with multiple languages and components (unit tests, build system, runtime, etc) organized., _(*3)

build/ and target/ are basically the same thing. Within one project you should probably pick one or the other and stick with it. target is a Maven convention. C and JavaScript people like to call it build., _(*4)

Database

Create the database

If you're using Vagrant, don't do this. Just vagrant up and you should be good to go. The following only applies if you want to run outside of Vagrant., _(*5)

make create-database will attempt to create the database for you based on configuration in config/dbc.json., _(*6)

If that fails (due to e.g. your system is not set up in a way for which that script is designed) you can create the database yourself:, _(*7)

Set up a new postgres database by logging in as root (sudo -u postgres psql often does the trick) and running:, _(*8)

CREATE DATABASE phptemplateprojectdatabase;
CREATE USER phptemplateprojectdatabaseuser WITH PASSWORD 'phptemplateprojectdatabasepassword';
GRANT ALL PRIVILEGES ON DATABASE phptemplateprojectdatabase TO phptemplateprojectdatabaseuser;

If you've changed the name of the database or user in config/dbc.json, make the corresponding changes to the above SQL., _(*9)

Initialize the database

Once a database exists and permissions are set up for our user, you should be able to run make rebuild-database, which will empty the database and rebuild it from the upgrade scripts., _(*10)

Rebuilding The Database

Run make rebuild-database to empty the database and rebuild it from the upgrade scripts in src/db-migrations/upgrades/., _(*11)

Run make rebuild-database-with-test-data to rebuild-database the database and also adddata from src/db-migrations/test-data/., _(*12)

Upgrading The Database

Run make upgrade-database to run newly made upgrade scripts in src/db-migrations/upgrades/., _(*13)

Unit Testing

All tests are in src/test/, _(*14)

The structure of src/test/ should mimic that of src/main/, where a single test file tests a single application file., _(*15)

To run PHPUnit tests, run make run-tests. This will run both unit and integration tests. Run make run-unit-tests to just run unit tests and make run-integration-tests to just run integration tests., _(*16)

Integration tests are ones that use the database., _(*17)

PHP Styles

Follow the conventions used by existing Phrebar code. Namely, tabs for leading indentation, opening brackets on the same line for functions and control structures., _(*18)

(It may be that 'tabs for leading indentation' and 'Smart Tabs' refer to the exact same practice.), _(*19)

Deploying

Deployment to the various environments is handled automatically by CircleCI. Read these docs about how Earthling has set up CircleCI., _(*20)

Web serving

If you're using Vagrant, you can just HTTP to whatever IP address you told Vagrant to use. e.g., _(*21)

http://192.168.250.250/, _(*22)

If you accepted the default., _(*23)

If you are running Apache (and Postgres, and other required programs) on your development machine, and this directory is checked out somewhere under the DocumentRoot or an Alias, you may be able to just browse to the www directory and have things work. For me, that's, _(*24)

http://my-local-machine/~my-username/proj/PHPTemplateProject/www/, _(*25)

Most people probably need to run Vagrant though., _(*26)