emmanuel1-byte/school-management-api

Fork to show the codemap and the bug report

School-Mangement-API

This is a School-Mangement API built with Nodejs + express js

Pre-requisites

• install Nodejs version v18.16.1

Getting Started

• clone the repository

  git clone <https://github.com/HilaryEmmanuel/School-Management-API.git>

• Install dependencies

  cd <School-Management-Api> npm install

• Build and run the project

  npm start

Testing

• all Endpoints are tested

Major Dependencies

• Express js - the core of the API
• Postgresql - the Relational database mangement system used
• sequelize - the Orm used
• supertest & mocha - packages used for testing
• jsonwebtoken - the package used for creation and verification of jwt token
• cloudinary - the cloud storage used for file upload

Api Documentation Postman

https://www.postman.com/cloudy-escape-698934/workspace/project-workspace/collection/24822385-beed9d45-989e-4e45-a219-c2e1c43d9004?action=share&creator=24822385&active-environment=24822385-a273b284-c908-4654-88f3-21310e5ccaa5