Family Tree

Containerized setup for REST API

Technology included

• Nginx
• MySQL
• PHP 7

Requirements

• Docker Native
• Docker Compose
• Docker Machine
• Virtualbox

Running

• Clone the repository.
• Change directory into the cloned project.
• Use the following command.

Configuration File

$ cp .env.example .env

First Time Setup

$ make install

Setup only the project

$ make containers_up

Stop the project and remove containers

$ make remove_containers

Stop the project and remove virtual machine

$ make destroy_machine

List of all supported commands

    make install                 -> creates the machine and then does the setup
    make containers_up           -> runs the projects setup (machine should already be available)
    make remove_containers       -> removes all the containers
    make destroy_machine         -> destroys the machine (everything will be gone :) )
    make project_config          -> shows the project configuration details
    make project_deps            -> fulfils the project dependancies (composer...)
    make run_tests               -> run the tests
    make migration               -> run the db migrations
    make seed_db                 -> populate some dummy data in the db
    make run_tests               -> Runs all the tests
    make build_coverage          -> Builds the code coverage report (www/restapi/coverage)