README.md

Welcome to the Road-Runner-Resource-Hub Backend Git Hub!

The goal of this project is to simplify communications between faculty, staff, admins, industry partners, and students to help eliviate the bombardment of information towards students and help hone in on just the information that pertains to THAT student. This github only includes the BACKEND code. Please see

• Frontend - For more information on the Frontend Code.
• Backend-Project-Board - For current know issues/Road map
• Backend-Wiki - For Developer API information

Developer Information

Installation

• cd /RoadRunner-Resource-Hub-Backend
• npm install
• install mongodb
• Create nodemon.json file in /RoadRunner-Resource-Hub-Backend

{
    "env": {
        "MongoDB_URL": "",
        "JWT_Key":""
    }
}

Deployment

• Download Heroku CLI - https://devcenter.heroku.com/articles/heroku-cli (also included in dev npm packages) -run

  heroku login

Tests

postman

Commands

npm run dev - starts up backend server npm run test - runs tests npm run test:cleanup - cleans up after tests.