matcher/README.md

12 lines
664 B
Markdown
Raw Normal View History

2023-04-06 09:12:49 +00:00
# Mobicoop V3 - Matcher
2023-04-06 06:57:21 +00:00
2023-04-06 09:12:49 +00:00
Mobility matching service for Mobicoop V3.
2023-04-06 06:57:21 +00:00
2023-04-06 09:12:49 +00:00
## Requirements
2023-04-06 06:57:21 +00:00
2023-04-06 09:12:49 +00:00
You need [Docker](https://docs.docker.com/engine/) and its [compose](https://docs.docker.com/compose/) plugin.
2023-04-06 06:57:21 +00:00
2023-04-06 09:12:49 +00:00
You also 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 (check that your local version matches with the one used in the Dockerfile).
2023-04-06 06:57:21 +00:00
2023-04-06 09:12:49 +00:00
The API will run inside a docker container, **but** the install itself is made outside the container, because during development we need tools that need to be available locally (eg. ESLint or Prettier with fix-on-save).