Skip to content

Commit 5596eaf

Browse files
authored
docs: Create recipe book (#87)
* feat: Create RECETTES.md * fix: RECETTES.md * docs: add seed in RECETTES.md * docs: v1.0.0 - clean * docs: v1.0.0 - functional tests * docs: v1.0.0 - structural tests * docs: v1.0.0 - structural tests & api documentation recipes * fix: v1.0.0 - structural tests & api documentation recipes * test(v1.0.0): version display * refactor: TODO * fix(v1.0.0): typo * style(v1.0.0): clean * style(v1.0.0): chapters * style(v1.0.0): chapters * style(v1.0.0): chapters * fix: typo * fix: typo * feat(v1.1.0): init version * docs: add seed command in README * docs: add database section in README * feat(v1.1.0): add functional tests * feat(v1.1.0): add profile functional test * feat(v1.1.0): add security tests * feat(v1.1.0): add auth requirements * fix(v1.1.0): typo * feat(v1.1.1): create version * fix(v1.1.1): typo * feat(v1.1.2): init version * fix(v1.1.2): coverage matrix * fix(v1.1.2): disable all coverage * fix(v1.1.2): typo
1 parent ce4db4f commit 5596eaf

File tree

2 files changed

+370
-6
lines changed

2 files changed

+370
-6
lines changed

README.md

Lines changed: 51 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,19 @@ npm install
6060
docker-compose up -d
6161
```
6262

63-
2. Launch the application in development mode
63+
2. Generate data with Prisma seed
64+
65+
```shell
66+
npm run prisma:seed
67+
```
68+
69+
3. Launch the application in development mode
6470

6571
```shell
6672
npm run dev
6773
```
6874

69-
3. Well done, the application is running!
75+
4. Well done, the application is running!
7076

7177
- UI : http://localhost:3000/ui (homepage)
7278
- API : http://localhost:3000/api/docs (Swagger documentation)
@@ -85,6 +91,15 @@ npm test
8591
npm run test:cov
8692
```
8793

94+
### Database
95+
96+
- Reset Prisma database
97+
98+
```shell
99+
npm run prisma:reset
100+
npm run prisma:seed
101+
```
102+
88103
<h2 id="macos">MacOS</h2>
89104

90105
### Installation
@@ -105,13 +120,19 @@ npm install
105120
docker-compose up -d
106121
```
107122

108-
2. Launch the application in development mode
123+
2. Generate data with Prisma seed
124+
125+
```shell
126+
npm run prisma:seed
127+
```
128+
129+
3. Launch the application in development mode
109130

110131
```shell
111132
npm run dev
112133
```
113134

114-
3. Well done, the application is running!
135+
4. Well done, the application is running!
115136

116137
- UI : http://localhost:3000/ui (homepage)
117138
- API : http://localhost:3000/api/docs (Swagger documentation)
@@ -130,6 +151,15 @@ npm test
130151
npm run test:cov
131152
```
132153

154+
### Database
155+
156+
- Reset Prisma database
157+
158+
```shell
159+
npm run prisma:reset
160+
npm run prisma:seed
161+
```
162+
133163
<h2 id="linux">Linux</h2>
134164

135165
### Installation
@@ -150,13 +180,19 @@ npm install
150180
docker-compose up -d
151181
```
152182

153-
2. Launch the application in development mode
183+
2. Generate data with Prisma seed
184+
185+
```shell
186+
npm run prisma:seed
187+
```
188+
189+
3. Launch the application in development mode
154190

155191
```shell
156192
npm run dev
157193
```
158194

159-
3. Well done, the application is running!
195+
4. Well done, the application is running!
160196

161197
- UI : http://localhost:3000/ui (homepage)
162198
- API : http://localhost:3000/api/docs (Swagger documentation)
@@ -174,3 +210,12 @@ npm test
174210
```shell
175211
npm run test:cov
176212
```
213+
214+
### Database
215+
216+
- Reset Prisma database
217+
218+
```shell
219+
npm run prisma:reset
220+
npm run prisma:seed
221+
```

0 commit comments

Comments
 (0)