Skip to content

Latest commit

 

History

History
153 lines (127 loc) · 7.46 KB

README.md

File metadata and controls

153 lines (127 loc) · 7.46 KB

Backend Documentation

Welcome to the backend documentation for our open-source project. This document provides an overview of the backend structure, API routes, and how to contribute to the project.

Table of Contents

Folder Structure

The backend folder is organized into several directories, each serving a specific purpose:

.
└── /backend/
    ├── /community/
    │   ├── /controllers   # Logic for handling API requests related to Communities and it's members
    │   ├── /middlewares   # Middleware functions for verifying admin and member status
    │   ├── /models        # Database models for community and community members
    │   ├── /routes        # API route definitions for community and community members
    │   ├── /services      # Reusable services specific to community members
    │   └── /utils         # Utility file defining constants for user roles
    ├── /contest/
    │   ├── /controllers   # Logic for handling API requests related to contests/
    │   │   └── /platforms   # APIs for fetching the upcoming contests on each of the coding platforms
    │   ├── /models        # Database models for contests
    │   └── /routes        # API route definitions for contests
    ├── /core/
    │   └── /api           # File defining custom error and success handler objects for responses
    ├── /DSA_sheets/
    │   ├── /controllers   # Logic for handling API requests realted to DSA sheets and DSA questions
    │   ├── /models        # Database models for DSA sheets and questions
    │   └── /routes        # API route definitions for DSA sheets and questions
    ├── /services/
    │   ├── /discord-webhook  
    │   └── /email
    ├── /users/
    │   ├── /controllers   # Logic for handling API requests related to users/
    │   │   └── /platforms   # Logic for fetching user's info on different coding platforms 
    │   ├── /middlewares   # Custom middleware functions specific to users
    │   ├── /models        # Database models for users
    │   ├── /routes        # API route definitions for users
    │   └── /services      # Reusable services and utilities specific to users
    └── index.js         # Main server file
  • backend: Main folder for the backend.
    • community: Controllers, middlewares, models, routes, services, and utils for community members.
      • controllers: Logic for handling API requests related to Communities and it's members
      • middlewares: Middleware functions for verifying admin and member status
      • models: Database models for community and community members
      • routes: API route definitions for community and community members
      • services: Reusable services specific to community members
      • utils: Utility file defining constants for user roles
    • contest: Controllers, models, and routes for contests.
      • controllers: Logic for handling API requests related to contests
        • platforms: APIs for fetching the upcoming contests on each of the coding platforms
      • models: Database models for contests
      • routes: API route definitions for contests
    • core: File defining custom error and success handler objects for responses
      • api: File defining custom error and success handler objects for responses
    • DSA_sheets: Controllers, models, and routes for DSA sheets and questions.
      • controllers: Logic for handling API requests realted to DSA sheets and DSA questions
      • models: Database models for DSA sheets and questions
      • routes: API route definitions for DSA sheets and questions
    • services: Reusable services and utilities specific to users
    • users: Controllers, middlewares, models, routes, services, and utils for users.
      • controllers: Logic for handling API requests related to users
        • platforms: Logic for fetching user's info on different coding platforms
      • middlewares: Custom middleware functions specific to users
      • models: Database models for users
      • routes: API route definitions for users
      • services: Reusable services and utilities specific to users
    • index.js: Main server file

Getting Started

Installation

  1. Clone the repository: git clone https://github.com/pranshugupta54/digitomize.git
  2. Navigate to the backend directory: cd digitomize/backend
  3. Install dependencies: npm install

Environment Variables

Configure your environment variables in the .env file. This file should contain sensitive information and configurations that your application needs, such as database connection strings, API keys, and more.

Example:

TEST=Env file connected.
MONGODB_URL=mongodb://127.0.0.1:27017/digitomize
PORT=4001
BACKEND_URL=http://localhost:4001
CONTESTS=true
USERS=true
NODE_ENV=development

# Firebase Configuration
FIREBASE_CREDENTIALS= # you need to add JSON for this

Creating a .env from the .example.env file template

  • Create a new .env file in the backend directory
  • Copy the contents of the .example.env in the the backend directory and paste them into your created .env file
  • Fill in the FIREBASE_CREDENTIALS= variable in JSON with the JSON credentials generated from your created firebase project (see below for instructions on how to get these credentials)

Firebase Credentials

To get credentials you should first have a firebase project. If you don't know how to make one please check Frontend Documentation.

  • Select your project.

  • Go to "Project Settings" by clicking on the gear icon next to "Project Overview" in the top-left corner.

  • Navigate to the "Service accounts" tab.

  • If you haven't created a service account yet, click on "Generate new private key."

  • This will generate a new service account key and automatically download it as a JSON file (serviceAccountKey.json). it will look something like this

    {
  "type": "service_account",
  "project_id": "your-project-id",
  "private_key_id": "your-private-key-id",
  "private_key": "-----BEGIN PRIVATE KEY-----\nYourPrivateKey\n-----END PRIVATE KEY-----\n",
  "client_email": "your-service-account-email@your-project-id.iam.gserviceaccount.com",
  "client_id": "your-client-id",
  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
  "token_uri": "https://oauth2.googleapis.com/token",
  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
  "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/your-service-account-email%40your-project-id.iam.gserviceaccount.com"
}

  • copy this entire thing and set it as the value of FIREBASE_CREDENTIALS in your .env file. (Make sure the entire json is placed on a single line)

Running the Server

Start the server: npm start

Linting

  • Run npm run lint to check for errors using the linter.
  • Run npm run lint-fix to have the linter automatically fix errors where possible.

API Routes