README.md

moncon API

---

📝 Table of Contents

• About
• Getting Started
• Built Using

🧐 About

This repository contains the moncon API.

🏁 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

You need NodeJS installed, at least version 14.

Installing

Install dependencies.

npm install

Configuration

• You need to have an instance of a MongoDB database, for example running a docker container with

docker run --name moncon-database -p 27017:27017 -d mongo

• Make a copy of the .env.example file with the name .env, and update it with your config
• You need to add the file firebaseServiceAccountKey.json containing the Firebase configuration

Development

To start the local development server execute the following command.

npm run dev

⛏️ Built Using

• NodeJs - Server Environment
• Express - Server Framework