Skip to content

Latest commit

 

History

History
126 lines (94 loc) · 2.83 KB

README.md

File metadata and controls

126 lines (94 loc) · 2.83 KB
Raw

MARKS MANAGEMENT SYSTEM - BACKEND

The backend server for the marks management system which is aimed to be used by universites and other educational institutes.

Features

  1. Supports Multiple User Type (Admin, Teacher, Student, ExamHead)
  2. Supports Bulk Data Import (csv)
  3. Student can view their marks, syllabus and other details.
  4. Teacher can add, view marks for their courses
  5. Admin can overview overall processes of the system.
  6. Supports multiple academic divisions: faculties, departments, programs and syllabus
  7. Supports more: Semester upgrade, marks mgmt and export, role mgmt, course mgmt,....

Necessary Tools

Make sure you have the following tools installed on your machine

  • Docker
  • Postman
  • Node
  • Pnpm
  • Vscode (extensions: Prettier, Prisma, Eslint, GitLens)

Run

  • Run 
    cp .env.example .env

    and edit .env file with required details (JWT_SECRET, DATABASE_URL,...)

  • Install dependencies 
    npm install -g pnpm && pnpm install
  • To setup database connection 
    pnpm exec prisma migrate dev
  • To run locally 
    pnpm run dev

Setting up Prisma (When you update schema)

  1. Update the prisma/schema.prisma file as necessary
  2. Run pnpm exec prisma migrate dev
    • This will update database and generate prisma client
  3. For more details :

Directory Structure

  • A basic project structure
  • Subject to change over time
.
└── src
    ├── db -> Where the db related files will be stored
    ├── index.js -> entry point for the node
    ├── middlewares -> Where the middlewares will stored
    └── routes -> Where the routes(controllers) will be stored

Postgres Setup

  • Method - 1
  1. Install docker on your machine
  2. Pull postgres image
docker pull postgres:latest
  1. Run the following command
docker run --name psql-dev \
-e POSTGRES_PASSWORD=test1234 \
-p 5432:5432 postgres

This will start a postgres instance at TCP port 5432 with username postgres and password test1234

  1. You can access the postgres acces as such
docker exec -it psql-dev bash
psql -h localhost -U postgres
  1. From next time, just run docker start psql-dev to start the container
  • Method-2
  1. Use the aiven.io postgres setup

Coding Guidelines

  1. Explicitly define response's status code
  2. Explicit return after sending response
  3. Explicitly set return content-type
res
  .status(401)
  .json(
    errorResponse(
      "Authentication Error",
      "Please provide valid login credentials."
    )
  )
return
  1. Explicity set request body content-type
  2. A database helper function should return with toResult() function

TODO

  • Add endpoint API documentation (use swagger)