Oeco Architectes website

Requirements

• PHP CLI (see required version in composer.json)
• Composer
• NodeJS with NPM (NVM setup recommended)

MacOS

Installation instructions:

# PHP & Composer
brew install php composer

# NVM and NodeJS
brew install nvm
nvm install node # latest

Linux/Unix

Use your regular package manager whenever possible. Otherwise, refer to PHP, Composer and NodeJS documentations.

Windows

Download and install:

• PHP for Windows
• Composer for Windows
• Latest Node.JS

Development environment

Development installation

# Install Composer dependencies, and initialize development environment
composer create-project

Development server

Run in two separate terminals:

# Start HTTP server
composer start

# Build client-side assets and watch for changes
composer watch

Open http://localhost:8000/.

Testing

PHP unit tests

composer test:php

Javascript unit tests

composer test:js

End-to-end tests

Run in two separate terminals:

composer start

composer test:e2e

Production environment

Server requirements

• Any HTTP server (Apache recommended)
• PHP module (see required version in composer.json) with the following extensions:
  • TODO

Production installation

# Install Composer runtime dependencies only
composer install --no-dev

Build production assets

composer build # Optimize Composer autoloader, and generate public/{css,fonts,js} assets.

Server setup

Serve public/ directory.

Continuous Delivery

Continuous delivery is setup as follows:

1. Each commit triggers a build on Travis CI, which runs linting (composer test) and all tests (composer test)
2. If the commit belongs to the master branch, deployment is done on the staging platform.
3. If the commit is a tag, deployment is done on the production platform.

See .travis.yml for details.

License

Copyright © 2018 Alex Mercier and Oeco Architectes. All rights reserved.