ncaron
/
ad
mirror of https://gitlab.com/mobicoop/v3/service/ad.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

update README

This commit is contained in:
Grégoire Chevalier 2023-06-06 10:22:50 +02:00
parent c4d26ad12c
commit 176b887380
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -10,6 +10,8 @@ You also need NodeJS installed locally : we **strongly** advise to install [Node
The API will run inside a docker container, **but** the install itself is made outside the container, because during development we need tools that need to be available locally (eg. ESLint or Prettier with fix-on-save). The API will run inside a docker container, **but** the install itself is made outside the container, because during development we need tools that need to be available locally (eg. ESLint or Prettier with fix-on-save).
A RabbitMQ instance is also required to send / receive messages when data has been inserted/updated/deleted.
## Installation ## Installation
- copy `.env.dist` to `.env` : - copy `.env.dist` to `.env` :
@ -95,7 +97,7 @@ The app exposes the following [gRPC](https://grpc.io/) services :
As mentionned earlier, RabbitMQ messages are sent after these events : As mentionned earlier, RabbitMQ messages are sent after these events :
- **Create** (message : the created user informations) - **Create** (message : the created ad informations)
## Tests / ESLint / Prettier ## Tests / ESLint / Prettier
@ -124,4 +126,4 @@ npm run pretty
## License ## License
Mobicoop V3 - User Service is [AGPL licensed](LICENSE). Mobicoop V3 - Ad Service is [AGPL licensed](LICENSE).