Giter Club home page Giter Club logo

hostel_web_client's Introduction

Project Documentation

Project Overview

  • Project Name: Hostel management API
  • Description: A RESTful API for managing hostel admission process.

API Implementation

  • Description: This section outlines the API endpoints and functionality that need to be implemented for the Hostel management API.

Endpoints to Implement

Middlewares (Utils)

  1. JWT Middleware
    • Description: Middleware for verifying JWT tokens.
    • Deadline: [Deadline]
    • Assigned To:[Developer Name]

Authentication Endpoints

  1. POST /auth/register

    • Description: Register a new staff/admin.
    • Deadline: [Deadline]
    • Assigned To: [Developer Name]

  2. POST /auth/login

    • Description: Login a user.
    • Deadline: [Deadline]
    • Assigned To: [Developer Name]

  3. PATCH/update/password

    • Description: update user's password.
    • Deadline: [Deadline]
    • Assigned To: [Developer Name]

User Endpoints

  1. GET /user

    • Description: Retrieve all student details.
    • Deadline: [Deadline]
    • Assigned To: [Developer Name]

  2. PATCH /user/:id

    • Description: Update student data specified by ID.
    • Deadline: [Deadline]
    • Assigned To: [Developer Name]

  3. POST /user

    • Description: Create a new student.
    • Deadline: [Deadline]
    • Assigned To: [Developer Name]

  4. POST /student/scorecalculaton

    • Description:calculation of score of a student according to weightage
    • Deadline: [Deadline]
    • Assigned To:developer Name

  5. POST /room/allocation

    • Description:calculate no of rooms as vacancies
    • Deadline: [Deadline]
    • Assigned To:developer Name

  6. POST /room/allotment

    • Description:allotment of a room
    • Deadline: [Deadline]
    • Assigned To:developer Name

Scheme Endpoints

  1. GET /scheme

    • Description: Retrieve all schemes.
    • Deadline: [Deadline]
    • Assigned To: [developer name]

  2. GET /scheme/:id

    • Description: Retrieve a specific scheme by ID.
    • Deadline: [Deadline]
    • Assigned To: [Developer Name]

  3. POST /scheme

    • Description: Create a new scheme.
    • Deadline: [Deadline]
    • Assigned To: [Developer Name]

  4. PUT /scheme/:id

    • Description: Update a specific scheme by ID.
    • Deadline: [Deadline]
    • Assigned To: [Developer Name]

  5. DELETE /scheme/:id

    • Description: Delete a specific scheme by ID.
    • Deadline: [Deadline]
    • Assigned To: [Developer Name]

Testing and Debugging

  • Description: This section outlines the testing and debugging phase of the project.

Testing Plan

  • Unit Testing: Test each API using Postman or Hoppscotch using dummy data.

hostel_web_client's People

Contributors

majid-2002 avatar 21b828 avatar

Watchers

avatar

Forkers

anjpr

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.