antoineprudhomme5/api.c-bieres.uttnetgroup.fr

Club bières server

API of the club bières web app.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

To run the API, you need :

• Node.js
• MongoDB

Installing

After cloning the project :

• Rename .env.example to .env and put your env's values
• Run npm install to install the project's dependencies
• Run npm start to run the api

Running the tests

No tests for the moment

Deployment

Deployment in production with dokku. Check .gitlab-ci.yml for more details.

Built With

• Express.js - The framework used
• Mongoose - The ORM

Authors

• prudywsh - Initial work

License

This project is licensed under the MIT License