@@ -17,24 +17,28 @@ The project is completely dockerized and supports the following environments:
1717=== Local development environment
1818
1919Local development environment is set up using Docker Compose. It means that all the required services (like database)
20- are set up in their own containers and connected in Docker Compose file, ready to be used. To run the local development
21- environment, simply run:
20+ are set up in their own containers and connected in Docker Compose file, ready to be used.
2221
23- [source,shell]
24- ----
25- docker compose -f compose_dev.yaml --env-file .env.docker up
26- ----
22+ ==== Setting up a project
2723
28- [NOTE]
29- ====
30- ProjectInit.sh automatically builds containers when setting up the project. However, if you have removed or cleaned up
31- inactive containers and/or images, you will have to build the containers again before running them:
24+ Setting up a new project does not require any additional manual configuration.
25+
26+ Transferring a project to another computer (ex. team members), requires a couple of steps:
27+
28+ * clone your project's repository
29+ * create `.env.docker` file in your project's root directory and add the following values:
30+ ** `PROJECTINIT_UID` - user ID. Can be obtained by running `id -u` on the host machine.
31+ ** `PROJECTINIT_GID` - group ID. Can be obtained by running `id -g` on the host machine.
32+ * check if your project uses Docker Compose secrets (in link:compose_dev.yaml[`compose_dev.yaml`]), create and fill the
33+ required secrets files
34+
35+ ==== Running the project on local
36+ To run the local development environment, simply run:
3237
3338[source,shell]
3439----
35- docker compose -f compose_dev.yaml --env-file .env.docker up --build
40+ docker compose -f compose_dev.yaml --env-file .env.docker up
3641----
37- ====
3842
3943=== Dev environment
4044
0 commit comments