aman7870/website-backend

The backend code for all our website-related apps

Real Dev Squad API

Table of Contents

• About the Project
• Running the Project
• Prerequisites
• API Documentation
• CONTRIBUTING

About the Project

This Project serves the backend APIs required for Real Dev Squad web projects. This project is built in Express.js.

Running the Project

$ npm install
$ npm start 

Running in dev mode

$ npm run dev

Prerequisites

• Create a new file: config/local.js. Override the required config values from config/development.js and config/default.js into config/local.js.
• Register the application for GitHub OAuth to get the clientId and clientSecret. Add the callback URL as http://<HOSTNAME>:<PORT>/auth/github/callback
• Create an application on FireStore and generate a service file. Add the service file with the name firestore-private-key.json in the project root.

API Documentation:

• Run the server and navigate to http://<HOSTNAME>:<PORT>/api-docs to view the API documentation.
• Alternatively, you can import the file API Schema to Postman or SwaggerHub.
• If any API changes have been made:
  • Write JS Doc on top of your routes using YAML based annotations in OPEN API 3.0 format.
  • Run npm run generate-api-schema to generate the API schema. A file public/apiSchema.json will be created/updated.