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-15 09:51:08 +01:00
parent d1fab1bd6b
commit 75402c90cd
1 changed files with 19 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -1,39 +1,42 @@
# Mobicoop V3 - User Service # Mobicoop V3 - User Service
Mobicoop V3 - User service. Mobicoop V3 - User service. Manages user-related data.
## Installation ## Installation
```bash You need [Docker](https://docs.docker.com/engine/) and [Docker-compose](https://docs.docker.com/compose/).
$ npm install
```
## Running the app Copy `.env.dist` to `.env` :
```bash ```bash
# development cp .env.dist .env
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
``` ```
and modify it to suit your needs.
Then execute :
```bash
docker-compose up -d
```
The app runs automatically on the port defined in `SERVICE_PORT` of `.env` file (default : _3001_).
## Test ## Test
```bash ```bash
# unit tests # unit tests
$ npm run test docker exec v3_user sh -c "npm run test"
# e2e tests # e2e tests
$ npm run test:e2e docker exec v3_user sh -c "npm run test:e2e"
# test coverage # test coverage
$ 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) !
## License ## License
Mobicoop V3 - User Service is [AGPL licensed](LICENSE). Mobicoop V3 - User Service is [AGPL licensed](LICENSE).