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

update readme

This commit is contained in:
Gsk54 2022-12-22 14:42:47 +01:00
parent 55383c879d
commit 7c09a56669
1 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -2,10 +2,14 @@
User-related data management. User-related data management.
## Installation ## Requirements
You need [Docker](https://docs.docker.com/engine/) and [Docker-compose](https://docs.docker.com/compose/). You need [Docker](https://docs.docker.com/engine/) and [Docker-compose](https://docs.docker.com/compose/).
A RabbitMQ instance is also required to send messages when data has been inserted/updated/deleted.
## Installation
Copy `.env.dist` to `.env` : Copy `.env.dist` to `.env` :
```bash ```bash
@ -33,7 +37,7 @@ sudo chown -R 5050:5050 postgresql/.pgadmin_data
Before using the app, you need to launch the database migration : Before using the app, you need to launch the database migration :
```bash ```bash
docker exec v3_user sh -c "npx prisma migrate dev" docker exec v3-user sh -c "npx prisma migrate dev"
``` ```
## Usage ## Usage
@ -85,14 +89,24 @@ The app exposes the following [gRPC](https://grpc.io/) services :
} }
``` ```
## Messages
A mentionned earlier, RabbitMQ messages are sent after these events :
- **Create** (message : the created user informations)
- **Update** (message : the updated user informations)
- **Delete** (message : the uuid of the deleted user)
## Test ## Test
```bash ```bash
# unit tests # unit tests
docker exec v3_user sh -c "npm run test" docker exec v3-user sh -c "npm run test"
# test coverage # test coverage
docker exec v3_user sh -c "npm run test:cov" docker exec v3-user sh -c "npm run test:cov"
``` ```
Note : you can run all npm commands directly _outside_ the container (see _scripts_ section of `package.json` for available commands), but you need NodeJS installed locally. We **strongly** advise to install [Node Version Manager](https://github.com/nvm-sh/nvm) and use the latest LTS version of Node. Note : you can run all npm commands directly _outside_ the container (see _scripts_ section of `package.json` for available commands), but you need NodeJS installed locally. We **strongly** advise to install [Node Version Manager](https://github.com/nvm-sh/nvm) and use the latest LTS version of Node.