ajay-mandal / classroom-api

The is classroom api developed using express, nodejs, prisma, javascript and postgresql

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Classroom - Backend API

This is a classroom Rapid API built using express and prisma. It needs some parameter validations. Will update soon....

Technology Used

Scripting Language : Javascript
For Backend : Nodejs, Express, Prisma
For Database : PostgreSQL / NeonDB
Other : jwswebtoken, cors

Features

  • Authentication endpoints for Signup and Login
  • Generate JWT token for registered user for further use
  • Middleware for authenticating users before any assignment operation
  • REST API Endpoints for adding new assignment
  • REST API Endpoints for viewing all available assignment
  • REST API Endpoints for modifying existing assignment
  • REST API Endpoints to delete any assignment
  • Created Dockerfile and published as private

To Run Locally

  1. Move to the directory
cd backend-classroom
  1. Install Dependencies
npm install
  1. Run the Server
node index.js

Note

  • I have included the Dockerfile to create a instance locally, just run
    docker build -t app-name .
  • My PC is ARM based so docker file image is using linux/arm but AMD image can en built using above command
  • If you are using M1/M2 Macbook then use below command to directly add my image to your dockerhub
    docker pull lordzexa/playpower-work:latest

API Documentation

Import this below file in Postman to check all backend calls
Link to JSON File

Highlights

Assignments Created Using POST

Duplicate Assignments Modified Using PUT

Delete Endpoint Validation

Delete Endpoint

Dockerized and pushed to private repo

About

The is classroom api developed using express, nodejs, prisma, javascript and postgresql


Languages

Language:JavaScript 87.2%Language:Dockerfile 12.8%