Reorganized documentation for production

Author: flavienbwk

README.md

@@ -22,11 +22,11 @@
 - [Logging and logs rotation](./api/app/utils/Logger.py#L12)
 - [Choose](./app/app/src/App.js#L65) between sidebar and navbar (or use both !)
 - Responsive design
-- Production and development builds
+- [Production](./prod.docker-compose.yml) and [development](./docker-compose.yml) builds
 
 ## API documentation
 
-I chose to use Swagger to document the API. Run the API following the steps below and go to [`http://localhost:5000`](http://localhost:5000).
+We've chosen Swagger to document the API. Run the API following the steps below and go to [`http://localhost:5000`](http://localhost:5000).
 
 Here you can take a look at the database architecture scheme :
 
@@ -44,11 +44,7 @@ With this boilerplate, you will be able to develop corporate-ready services AND
 
 ## Getting started (development)
 
-The API is made to run with an LDAP server for managing users. Whether use the provided Docker LDAP server or remove the conf. in [`docker-compose.yml`](./docker-compose.yml) and use your own LDAP server.
-
-This section will explain to you how to run this project and set-up the LDAP server with one user.
-
-### 1. Starting authentication services
+This section will explain how to properly run this project and set-up the LDAP server with one user.
 
 1. Copy the `.env.example` to `.env`
 
@@ -58,52 +54,82 @@ This section will explain to you how to run this project and set-up the LDAP ser
 
     > This is a good practice so your `.env` can't be committed along with your modifications (is in `.gitignore`)
 
-2. Change the database/LDAP passwords and keys in `.env`
-
-    Then run :
+2. Start the authentication services
 
     ```bash
     docker-compose up ldap phpldapadmin database adminer -d
     ```
 
-- **adminer** (PostgreSQL management) will be available at `http://localhost:8082`  
-- **phpLDAPAdmin** (LDAP management) will be available at `https://localhost:8081`
+   - **phpLDAPAdmin** (LDAP management) will be available at `https://localhost:8081`
+   - **adminer** (PostgreSQL management) will be available at `http://localhost:8082`
+
+    **Create** your first user by accessing phpLDAPAdmin at `https://localhost:8081` and [following the LDAP user creation guide](./CREATE_LDAP_USER.md).
+
+3. NGINX reverse-proxy
+
+    This boilerplate includes NGINX as a reverse proxy so we can have a unique endpoint for our app and API. Else, we would have to open two endpoints : one for the app, the other for the API.
+
+    ```bash
+    docker-compose up --build -d nginx
+    ```
 
-### 2. Creating the first user in the LDAP
+    > NGINX will auto restart until you have started the app and API below.
 
-Access phpLDAPAdmin at `https://localhost:8081` and [follow the LDAP user creation guide](./CREATE_LDAP_USER.md) to add your first user
+4. Run the API
 
-### 3. NGINX reverse-proxy
+    The database will be automatically set-up thanks to Flask Migrate and any future modification brought to [models](./api/app/model) will be automatically applied when the API is **restarted**.
 
-This boilerplate includes NGINX as a reverse proxy so we can have a unique endpoint for our app and API. Else, we would have to open two endpoints : one for the app, the other for the API.
+    You might wait some time before the database get updated after starting the API :
 
-```bash
-docker-compose up --build -d nginx
-```
+    ```bash
+    docker-compose up --build -d api
+    ```
 
-NGINX will auto restart until you have started the app and API below.
+    > For development, go to [`http://localhost:5000`](http://localhost:5000) to access the API documentation
 
-### 4. Run the API
+5. Run the web app
 
-The database will be automatically set-up thanks to Flask Migrate and any future modification brought to [models](./api/app/model) will be automatically applied when the API is **restarted**.
+    ```bash
+    # Expect several minutes for first launch (npm install)
+    docker-compose up --build -d app
+    ```
 
-You might wait some time before the database get updated after starting the API :
+    > :information_source: If you want to add a NPM package, just stop & re-launch `docker-compose up app`.
 
-```bash
-docker-compose up --build -d api
-```
+    Enjoy the app on [`http://localhost:8080`](http://localhost:8080)
 
-> For development, go to [`http://localhost:5000`](http://localhost:5000) to access the API documentation
+## Deploy to production
 
-### 5. Run the web application
+1. Prepare environment configuration
 
-:clock9: NPM's initial install may take quite a lot of time
+    Copy `.env.example` to `.env` and **edit** the passwords, keys and credentials
 
-```bash
-# Expect several minutes for first launch (npm install)
-docker-compose up --build -d app
-```
+    Use the provided Docker LDAP server or edit the config to use your own.
 
-Enjoy the app on [`http://localhost:8080`](http://localhost:8080)
+    ```bash
+    cp .env.example .env
+    ```
+
+2. Build the application for production
+
+    ```bash
+    docker-compose -f prod.docker-compose.yml build
+    ```
+
+3. Start the authentication services
+
+    ```bash
+    docker-compose up ldap phpldapadmin database adminer -d
+    ```
+
+    **Create** your first user by accessing phpLDAPAdmin at `https://localhost:8081` and [following the LDAP user creation guide](./CREATE_LDAP_USER.md).
+
+    :information_source: We recommend you to hide this service behind a firewall
+
+4. Run the application
+
+    ```bash
+    docker-compose -f prod.docker-compose.yml up nginx api app -d
+    ```
 
-> :information_source: If you want to add a NPM package, just stop & re-launch `docker-compose up app`.
+    Access the UI at `https://localhost:8080`

docker-compose.yml

@@ -85,6 +85,9 @@ services:
     volumes:
       - ./nginx/proxy.conf:/etc/nginx/conf.d/proxy.conf:ro
       - ./logs/nginx:/var/log/nginx
+    depends_on:
+      - api
+      - app
 
 volumes:
   database:

prod.docker-compose.yml

@@ -77,6 +77,9 @@ services:
       - "8080:80"
     volumes:
       - nginx_logs:/var/log/nginx
+    depends_on:
+      - api
+      - app
 
 volumes:
   api_logs: