Commit 62328a0d authored by Florent Chehab's avatar Florent Chehab

fix(doc, set_up): improved setup documentation

parent 42730df7
......@@ -30,7 +30,7 @@ This projects takes advantage of `docker` and `docker-compose` to ease the setup
- [`docker`](https://docs.docker.com/install/)
- [`docker-compose`](https://docs.docker.com/compose/install/)
*To run `Docker` your user needs to belong to the `docker` user-group (creating during the install process) or to `sudo` all `docker`-related commands. The last solution is a bit annoying when devlopping, so you can add your user to the `docker` group: `sudo usermod -aG docker your-user`. You can find what is your use with the command `whoami`. **The change will take effect after you restart your computer (or close your session and reopen it)**.*
*To run `Docker` your user needs to belong to the `docker` user-group (creating during the install process) or to `sudo` all `docker`-related commands. The last solution is a bit annoying when developing, so you can add your user to the `docker` group: `sudo usermod -aG docker your-user`. You can find "who" is your user with the command `whoami`. **The change will take effect after you restart your computer (or close your session and reopen it)**.*
Once this is done, don't forget that you need to have docker running before using `docker-compose`. For example, on `Fedora 29` you need to run the following command:
......@@ -48,13 +48,15 @@ Finally you can start-up all `docker` related *stuff* using the command:
make up--build
```
**When you lunch the project for the first time you'll most likely have the backend container crash due to the lack of some static files. Make sure not to stop the lunch process until you see `frontend_1 | ℹ 「wdm」: Compiled successfully` in the console. Then you can stop the command (`CTRL+C`) and do `make up`; you shouldn't have issues thereafter.**
**When you launch the project for the first time you'll most likely have the backend container crash due to the lack of some static files. Make sure not to stop the launch process until you see `frontend_1 | ℹ 「wdm」: Compiled successfully` in the console. Then you can stop the command (`CTRL+C`) and do `make up`; you shouldn't have issues thereafter.**
You can look at the `Makefile` to have more information on that last command and the other ones that are available.
To start all the `docker` images you will then only need to use the `make up` command.
**Important: the `make up` command actually lunches `docker-compose` in an *attached* mode, so that you can easily access the logs of the docker containers. If you quit it (e.g. with `CTRL+C`), this will stop all the docker containers. So usually, you should lunch it in one shell, don't touch that shell and use another one for all other `make` command related to the containers that were lunched.**
## Initialization
......@@ -63,6 +65,8 @@ To start all the `docker` images you will then only need to use the `make up` co
To initialize the database associated with the project, you need to connect to the `backend` image:
*(As explained in the **important** section, this has to be done in another shell than the one you used for the `make up` command.)*
```bash
make shell_backend
```
......@@ -87,7 +91,7 @@ Then:
```
_NB: this last command should be run everytime you migrate (modify/add) some models._
_NB: this last command should be run every time you migrate (modify/add) some models._
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment