user/README.md

# Mobicoop V3 - User Service

Mobicoop V3 - User service. Manages user-related data.

## Installation

You need [Docker](https://docs.docker.com/engine/) and [Docker-compose](https://docs.docker.com/compose/).

Copy `.env.dist` to `.env` :

```bash
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
docker exec v3_user sh -c "npm run test"

# e2e tests
docker exec v3_user sh -c "npm run test:e2e"

# test coverage
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).
add prisma 2022-12-13 14:27:28 +00:00			`# Mobicoop V3 - User Service`
Initial commit 2022-12-13 12:31:25 +00:00
update readme 2022-12-15 08:51:08 +00:00			`Mobicoop V3 - User service. Manages user-related data.`
Initial commit 2022-12-13 12:31:25 +00:00
initial commit 2022-12-13 12:39:06 +00:00			`## Installation`
Initial commit 2022-12-13 12:31:25 +00:00
update readme 2022-12-15 08:51:08 +00:00			`You need [Docker](https://docs.docker.com/engine/) and [Docker-compose](https://docs.docker.com/compose/).`
Initial commit 2022-12-13 12:31:25 +00:00
update readme 2022-12-15 08:51:08 +00:00			Copy `.env.dist` to `.env` :
Initial commit 2022-12-13 12:31:25 +00:00
initial commit 2022-12-13 12:39:06 +00:00			```bash
update readme 2022-12-15 08:51:08 +00:00			`cp .env.dist .env`
			```

			`and modify it to suit your needs.`
Initial commit 2022-12-13 12:31:25 +00:00
update readme 2022-12-15 08:51:08 +00:00			`Then execute :`
Initial commit 2022-12-13 12:31:25 +00:00
update readme 2022-12-15 08:51:08 +00:00			```bash
			`docker-compose up -d`
initial commit 2022-12-13 12:39:06 +00:00			```
Initial commit 2022-12-13 12:31:25 +00:00
update readme 2022-12-15 08:51:08 +00:00			The app runs automatically on the port defined in `SERVICE_PORT` of `.env` file (default : _3001_).

initial commit 2022-12-13 12:39:06 +00:00			`## Test`
Initial commit 2022-12-13 12:31:25 +00:00
initial commit 2022-12-13 12:39:06 +00:00			```bash
			`# unit tests`
update readme 2022-12-15 08:51:08 +00:00			`docker exec v3_user sh -c "npm run test"`
Initial commit 2022-12-13 12:31:25 +00:00
initial commit 2022-12-13 12:39:06 +00:00			`# e2e tests`
update readme 2022-12-15 08:51:08 +00:00			`docker exec v3_user sh -c "npm run test:e2e"`
Initial commit 2022-12-13 12:31:25 +00:00
initial commit 2022-12-13 12:39:06 +00:00			`# test coverage`
update readme 2022-12-15 08:51:08 +00:00			`docker exec v3_user sh -c "npm run test:cov"`
initial commit 2022-12-13 12:39:06 +00:00			```
Initial commit 2022-12-13 12:31:25 +00:00
update readme 2022-12-15 08:51:08 +00:00			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) !

Initial commit 2022-12-13 12:31:25 +00:00			`## License`

add prisma 2022-12-13 14:27:28 +00:00			`Mobicoop V3 - User Service is [AGPL licensed](LICENSE).`