Skip to content

Commit a3f5f4b

Browse files
committed
Update README with up and down server instructions
1 parent a1f4db4 commit a3f5f4b

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,26 @@ yarn
2121
yarn test:watch
2222
```
2323

24+
3. Get the server and database up:
25+
26+
```terminal
27+
yarn dev
28+
```
29+
30+
To stop the server watch, just press `Ctrl + c`.
31+
32+
4. Stop docker after get server down:
33+
34+
```
35+
yarn docker:down
36+
```
37+
38+
5. Destroy all data from DB:
39+
40+
```
41+
yarn docker:destroy
42+
```
43+
2444
## Scripts
2545

2646
| Script | Description |
@@ -94,7 +114,7 @@ This project uses Hexagonal Architecture (Ports & Adapters) with Functional Prog
94114
| `src/core/types` | Here you can put the types that are not related with any of your domains or entities. |
95115
| `src/helpers` | Here you can put your global helpers. |
96116
| `src/ports` | Anything with external world contact. When you need to access something on `core`, you must use an `adapter`. |
97-
| `src/ports/adapters` | Adapters for ports. For example: You can have a `database` adapter that can use `Postgres` ou `MariaDB`. An `http` adapter that can consume `express` or `fastify`. |
117+
| `src/ports/adapters` | Adapters for ports. For example: You can have a `database` adapter that can use `Postgres` or `MariaDB`. An `http` adapter that can consume `express` or `fastify`. |
98118
| `src/ports/<port>` | Here you can create your raw `ports` with real implementation: `express` / `fastify` as http server, `postgres` / `mariadb` as databases, etc. |
99119
| `.env.example` | List of Environment Variables. Please, copy this file and create a new `.env` file to use Env Vars. |
100120
| `jest.config.integration.js` | Jest configuration file for integration tests. |

0 commit comments

Comments
 (0)