Skip to content

Latest commit

 

History

History
78 lines (52 loc) · 1.96 KB

README.md

File metadata and controls

78 lines (52 loc) · 1.96 KB

Student Web Server

Student Web Server is a RESTful API that manages students' and courses' information. The API performs CRUD operations on student and course data (stored in MongoDB), and returns the results in JSON format. The API can allow students to register for courses, and students can view their current courses.

Table of Contents

Motivation

Student Web Server was inspired by my college schedule builder. I wanted to create a web application that would allow students to create their own schedules by adding courses to their schedule or removing courses from their schedule.

Installation

Use the package manager npm to install Student Web Server.

npm install

Usage

Use the following commands to start the application.

npm start

Users are required set the environment variables for the application to work. eg. DB_CONNECTION for the database connection JWT_SECRET for the JWT token secret JWT_REFRESH_ACCESS_TOKEN for the JWT refresh token secret

Tools

Student Web Server uses the following tools: Node.js, NPM, MongoDB, Mongoose, Express, Passport, JWT, Bcrypt, JOI

Demo

API Testing

The API has test cases for all the endpoints. The API is tested using the following tools: JEST command for running the tests:

npm run test

Authors

Student Web Server was created and maintained by:

Daniel Adedeji

with the memtorship of:

Russell Pollari