Skip to content

Commit 5a647f7

Browse files
committed
📚 docs: update readme
1 parent efa9491 commit 5a647f7

2 files changed

Lines changed: 36 additions & 6 deletions

File tree

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,21 +102,36 @@ npm run test
102102
103103
## Docker Scripts In Project
104104

105-
run your project in docker to production:
105+
run your project in docker to production (docker-compose -f ./docker-compose.yml up):
106106
```shell
107107
npm run docker:prod
108108
```
109109

110-
run your project in docker to development:
110+
run your project in docker to development (docker-compose -f ./docker-compose.dev.yml up):
111111
```shell
112112
npm run docker:dev
113113
```
114114

115-
run your project in docker to test:
115+
run your project in docker to test (docker-compose -f ./docker-compose.test.yml up):
116116
```shell
117117
npm run docker:test
118118
```
119119

120+
run your project in docker to production (docker-compose -f ./docker-compose.yml up --build):
121+
```shell
122+
npm run docker:prod:build
123+
```
124+
125+
run your project in docker to development (docker-compose -f ./docker-compose.dev.yml up --build):
126+
```shell
127+
npm run docker:dev:build
128+
```
129+
130+
run your project in docker to test (docker-compose -f ./docker-compose.test.yml up --build):
131+
```shell
132+
npm run docker:test:build
133+
```
134+
120135
## Future Features
121136

122137
- [ ] Explain how design patters used in your initial configuration of project

project/README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,21 +57,36 @@ npm run test
5757
5858
## Docker scripts
5959

60-
run your project in docker to production:
60+
run your project in docker to production (docker-compose -f ./docker-compose.yml up):
6161
```shell
6262
npm run docker:prod
6363
```
6464

65-
run your project in docker to development:
65+
run your project in docker to development (docker-compose -f ./docker-compose.dev.yml up):
6666
```shell
6767
npm run docker:dev
6868
```
6969

70-
run your project in docker to test:
70+
run your project in docker to test (docker-compose -f ./docker-compose.test.yml up):
7171
```shell
7272
npm run docker:test
7373
```
7474

75+
run your project in docker to production (docker-compose -f ./docker-compose.yml up --build):
76+
```shell
77+
npm run docker:prod:build
78+
```
79+
80+
run your project in docker to development (docker-compose -f ./docker-compose.dev.yml up --build):
81+
```shell
82+
npm run docker:dev:build
83+
```
84+
85+
run your project in docker to test (docker-compose -f ./docker-compose.test.yml up --build):
86+
```shell
87+
npm run docker:test:build
88+
```
89+
7590
## Folder Structure
7691

7792
Your project get this structure

0 commit comments

Comments
 (0)