Skip to content

Commit 41f888f

Browse files
committed
update docs
I'm added Docker installation page if someaone wants to use it, i change the commands yarn start, yarn dev, yarn debug to the respective docker-compose commands and separate running commands for "With Docker" and "Locally", in "Locally" i left it as it was. update docs
1 parent 64adb85 commit 41f888f

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,29 @@ This version of the boilerplate is still in beta, so might contain abstractions
1010

1111
## How to run the server
1212

13+
### Requisites
14+
* To run the project wit Docker you need to have Docker installed in your computer: [Docker](https://docs.docker.com/engine/install/)
15+
* To run locally you need to have project dependencies installed globally in your machine
16+
1317
During development, the project can be run in two different ways.
1418

19+
### With Docker
20+
1521
If you want to just run the application in development mode, use the following command:
1622

23+
```sh
24+
$ docker compose up
25+
```
26+
27+
To run the application in debug mode in a way that the execution will stop when a debugger statement is called, use:
28+
29+
```sh
30+
$ docker-compose -f docker-compose.yaml -f docker-compose.debug.yaml up
31+
```
32+
33+
### Locally
34+
35+
If you want to just run the application in development mode, use the following command:
1736
```sh
1837
$ yarn dev
1938
```
@@ -44,9 +63,19 @@ $ yarn remote [server address] [REPL port]
4463

4564
## Tests
4665

47-
The boilerplate is prepared to run tests using Jest. We usually group the tests in folders called `__tests__` (following Jest convention) for each module of the application. To run the tests use the following command:
66+
The boilerplate is prepared to run tests using Jest. We usually group the tests in folders called `__tests__` (following Jest convention) for each module of the application. To run the tests use the following commands:
4867

68+
### With Docker
4969
```sh
70+
$ docker compose up
71+
72+
$ yarn test
73+
```
74+
75+
### Locally
76+
```sh
77+
$ yarn dev
78+
5079
$ yarn test
5180
```
5281

@@ -81,6 +110,17 @@ This boilerplate follows ideas from multiple good software development practices
81110

82111
To run your app in production mode, you'll need to follow these steps:
83112

113+
### With Docker
114+
115+
1. Define any environment variable important for production
116+
2. Go to `docker-compose.production.yaml` file, and add necessary configurations
117+
3. Run the following command:
118+
```sh
119+
$ docker-compose -f docker-compose.yaml -f docker-compose.production.yaml up
120+
```
121+
122+
### Locally
123+
84124
1. Build the application with `yarn build`
85125
2. Define any environment variable important for production
86126
3. Start the app with `yarn start`

0 commit comments

Comments
 (0)