barmmie/vendee

API: Getting started

To get started, make sure you have Docker installed on your system, and then clone this repository.

Next, navigate in your terminal to the directory you cloned this, and spin up the containers for the web server by running docker-compose up -d --build app.

Note: Your MySQL database host name should be mysql, not localhost. The username and database should both be homestead with a password of secret.

Bringing up the Docker Compose network with app instead of just using up, ensures that only the site's containers are brought up at the start, instead of all of the command containers as well. The following are built for our web server, with their exposed ports detailed:

• nginx - :8080
• mysql - :33306
• php - :9000

Three additional containers are included that handle Composer, NPM, and Artisan commands without having to have these platforms installed on your local computer.
Examples

• docker-compose run --rm composer update
• docker-compose run --rm artisan migrate

Web Interface

To get the Web interface:

• cd into the web folder
• run yarn install && yarn dev to start the web
• Web should be accessible at localhost:3000