dead8309 / faculty-api-nodejs

faculty-api-nodejs

Faculty Review API

Table of Contents

• About
• Tech Stack
• Getting Started

About

This is a RESTful API for the Faculty Review application.

Tech Stack

• NodeJS
• FeathersJS
• MongoDB
• Mongoose
• TypeScript
• Firebase

Getting Started

Getting up and running is as easy as 1, 2, 3.

1. Make sure you have NodeJS and npm installed.
2. Clone this repository and install its dependencies:

git clone https://github.com/iot-lab-kiit/faculty-api-nodejs

cd faculty-api-nodejs

yarn

3. Configure environment variables:

Add mongoDB connection string. Check .env.example for reference.

4. Add firebase service account

Add firebase service account configs in the src/service.json. Check service.json.example for reference.

5. Start your app locally:

yarn local