update readme
This commit is contained in:
parent
d1fab1bd6b
commit
75402c90cd
35
README.md
35
README.md
|
@ -1,39 +1,42 @@
|
|||
# Mobicoop V3 - User Service
|
||||
|
||||
Mobicoop V3 - User service.
|
||||
Mobicoop V3 - User service. Manages user-related data.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
$ npm install
|
||||
```
|
||||
You need [Docker](https://docs.docker.com/engine/) and [Docker-compose](https://docs.docker.com/compose/).
|
||||
|
||||
## Running the app
|
||||
Copy `.env.dist` to `.env` :
|
||||
|
||||
```bash
|
||||
# development
|
||||
$ npm run start
|
||||
|
||||
# watch mode
|
||||
$ npm run start:dev
|
||||
|
||||
# production mode
|
||||
$ npm run start:prod
|
||||
cp .env.dist .env
|
||||
```
|
||||
|
||||
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
|
||||
|
||||
```bash
|
||||
# unit tests
|
||||
$ npm run test
|
||||
docker exec v3_user sh -c "npm run test"
|
||||
|
||||
# e2e tests
|
||||
$ npm run test:e2e
|
||||
docker exec v3_user sh -c "npm run test:e2e"
|
||||
|
||||
# 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
|
||||
|
||||
Mobicoop V3 - User Service is [AGPL licensed](LICENSE).
|
||||
|
|
Loading…
Reference in New Issue