Subterfuge Backend

Setup Instructions

Step 1: Docker is supposed to run on Linux machines, but Windows support is provided by the Docker Toolbox. Follow the steps from here: https://docs.docker.com/toolbox/toolbox_install_windows/

Step 2: Open the Docker Quickstart Terminal

Step 3: Browse to the root folder of this project, for example:

cd ~/PhpstormProjects/subterfuge-backend/

Step 4: Copy the .env.example file and adjust its values if desired. You may leave them as they are for local development. You can simply do this from your IDE/Explorer as well.

cp .env.example .env

Step 5: Run the Docker containers:

docker-compose up -d

Step 6: Upon first run, Docker will build the images. This may take a short time and produce a lot of output, especially when compiling PHP extensions. However you should not need to do anything.

Step 7: Verify that the application is working by asking Docker to display the running containers. You should see two containers, one for the app (PHP) and one for the database (MySQL).

docker ps

Step 8: We need to go inside the PHP container to install the composer packages. You can do that as follows:

docker-compose exec app bash
cd sandbox
composer install

Step 9: Set the application key for the Laravel installation:

php artisan key:generate

You should see the environment variable APP_KEY gets filled in the .env file.

Step 10: Run the migrations.

php artisan migrate

Step 11: Run the seeds.

php artisan db:seed

Once completed, you can send requests to http://192.168.99.100/api.