MnE---Backend

Monitoring and Evaluation System

Description

MnE-Backend is a Monitoring and evaluation system.

Table of Contents

• Setup
  • Dependencies
  • Getting Started
  • Environment Variables
  • Database and ORM
• License

Setup

Dependencies

• NodeJS - A JavaScript runtime environment
• Express - A web application framework for NodeJS
• Sequelize - A promise-based ORM for NodeJS
• Eslint - A linting utility for JavaScript
• Babel - A JavaScript compiler

Getting Started

Follow these steps to set up the project in development mode

• Install Nodejs
• Clone the repository by running the command

  git clone https://github.com/Benkimeric/MnE-Backend.git
  

• Run cd MnE-Backend to enter the application's directory
• Install the application's dependencies by running the command

  yarn install
  

• Create a .env file in the root of your directory using the .env.example file in the repository
• Start the application by running

  yarn start:dev
  

  The application should now be running at http://127.0.0.1:PORT. (replace PORT with what you have in your .env)

Environment Variables

Create your .env file in the root directory by following the .env.example below

  PORT=
  NODE_ENV=
  DATABASE_UR=
  DATABASE_DIALECT=
  JWT_SECRET_KEY=

Database and ORM

• Create a database in PostgreSQL and name it mne-app
• Run database migrations

  yarn run db:migrate and yarn run yarn db:seed
  

• Check the database and confirm that the users table has been created

License

This application is licensed under the terms of the MIT License