Skip to content
This repository was archived by the owner on Aug 16, 2025. It is now read-only.

Commit 60c9bb8

Browse files
committed
Generated documentation update.
1 parent dc16c37 commit 60c9bb8

2 files changed

Lines changed: 32 additions & 24 deletions

File tree

src/language/node/nestjs/container/docker/doc/PROJECTINIT_README_v1.adoc

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,24 +17,28 @@ The project is completely dockerized and supports the following environments:
1717
=== Local development environment
1818

1919
Local 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

src/language/php/symfony/container/docker/doc/PROJECTINIT_README_v1.adoc

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,28 @@ The project is completely dockerized and supports the following environments:
1818
=== Local development environment
1919

2020
Local development environment is set up using Docker Compose. It means that all the required services (like database)
21-
are set up in their own containers and connected in Docker Compose file, ready to be used. To run the local development
22-
environment, simply run:
21+
are set up in their own containers and connected in Docker Compose file, ready to be used.
2322

24-
[source,shell]
25-
----
26-
docker compose -f compose_dev.yaml --env-file .env.docker up
27-
----
23+
==== Setting up a project
2824

29-
[NOTE]
30-
====
31-
ProjectInit.sh automatically builds containers when setting up the project. However, if you have removed or cleaned up
32-
inactive containers and/or images, you will have to build the containers again before running them:
25+
Setting up a new project does not require any additional manual configuration.
26+
27+
Transferring a project to another computer (ex. team members), requires a couple of steps:
28+
29+
* clone your project's repository
30+
* create `.env.docker` file in your project's root directory and add the following values:
31+
** `PROJECTINIT_UID` - user ID. Can be obtained by running `id -u` on the host machine.
32+
** `PROJECTINIT_GID` - group ID. Can be obtained by running `id -g` on the host machine.
33+
* check if your project uses Docker Compose secrets (in link:compose_dev.yaml[`compose_dev.yaml`]), create and fill the
34+
required secrets files
35+
36+
==== Running the project on local
37+
To run the local development environment, simply run:
3338

3439
[source,shell]
3540
----
36-
docker compose -f compose_dev.yaml --env-file .env.docker up --build
41+
docker compose -f compose_dev.yaml --env-file .env.docker up
3742
----
38-
====
3943

4044
=== Dev environment
4145

0 commit comments

Comments
 (0)