logger/README.md

# Mobicoop V3 - Logger Service

Logging system for all services.

## Requirements

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

A RabbitMQ instance is also required to receive messages from other services.

## Installation

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 : _5099_).

## Test

```bash
# unit tests
docker exec v3-user sh -c "npm run test"

# 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) and use the latest LTS version of Node.

## License

Mobicoop V3 - Logger Service is [AGPL licensed](LICENSE).
initial commit 2022-12-23 15:36:23 +00:00			`# Mobicoop V3 - Logger Service`
Initial commit 2022-12-23 15:20:08 +00:00
initial commit 2022-12-23 15:36:23 +00:00			`Logging system for all services.`
Initial commit 2022-12-23 15:20:08 +00:00
initial commit 2022-12-23 15:36:23 +00:00			`## Requirements`
Initial commit 2022-12-23 15:20:08 +00:00
initial commit 2022-12-23 15:36:23 +00:00			`You need [Docker](https://docs.docker.com/engine/) and [Docker-compose](https://docs.docker.com/compose/).`
Initial commit 2022-12-23 15:20:08 +00:00
initial commit 2022-12-23 15:36:23 +00:00			`A RabbitMQ instance is also required to receive messages from other services.`
Initial commit 2022-12-23 15:20:08 +00:00
initial commit 2022-12-23 15:36:23 +00:00			`## Installation`
Initial commit 2022-12-23 15:20:08 +00:00
initial commit 2022-12-23 15:36:23 +00:00			Copy `.env.dist` to `.env` :
Initial commit 2022-12-23 15:20:08 +00:00
initial commit 2022-12-23 15:36:23 +00:00			```bash
			`cp .env.dist .env`
Initial commit 2022-12-23 15:20:08 +00:00			```

initial commit 2022-12-23 15:36:23 +00:00			`and modify it to suit your needs.`
Initial commit 2022-12-23 15:20:08 +00:00
initial commit 2022-12-23 15:36:23 +00:00			`Then execute :`
Initial commit 2022-12-23 15:20:08 +00:00
initial commit 2022-12-23 15:36:23 +00:00			```bash
			`docker-compose up -d`
			```
Initial commit 2022-12-23 15:20:08 +00:00
initial commit 2022-12-23 15:36:23 +00:00			The app runs automatically on the port defined in `SERVICE_PORT` of `.env` file (default : _5099_).
Initial commit 2022-12-23 15:20:08 +00:00
initial commit 2022-12-23 15:36:23 +00:00			`## Test`
Initial commit 2022-12-23 15:20:08 +00:00
initial commit 2022-12-23 15:36:23 +00:00			```bash
			`# unit tests`
			`docker exec v3-user sh -c "npm run test"`
Initial commit 2022-12-23 15:20:08 +00:00
initial commit 2022-12-23 15:36:23 +00:00			`# test coverage`
			`docker exec v3-user sh -c "npm run test:cov"`
			```
Initial commit 2022-12-23 15:20:08 +00:00
initial commit 2022-12-23 15:36:23 +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) and use the latest LTS version of Node.
Initial commit 2022-12-23 15:20:08 +00:00
			`## License`

initial commit 2022-12-23 15:36:23 +00:00			`Mobicoop V3 - Logger Service is [AGPL licensed](LICENSE).`