https://github.com/mrchukwu/student_records_api
RESTful student API service
https://github.com/mrchukwu/student_records_api
cookie-parser express jsonwebtoken mongodb mongoose nodej validator
Last synced: 7 months ago
JSON representation
RESTful student API service
- Host: GitHub
- URL: https://github.com/mrchukwu/student_records_api
- Owner: mrchukwu
- Created: 2025-06-21T22:43:37.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-06-24T09:39:26.000Z (7 months ago)
- Last Synced: 2025-06-24T10:41:52.148Z (7 months ago)
- Topics: cookie-parser, express, jsonwebtoken, mongodb, mongoose, nodej, validator
- Language: JavaScript
- Homepage:
- Size: 33.2 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# STUDENT RECORD API
- A simple RESTful CRUD service for managing Student records using MongoDB as the datastore. Your service should allow clients to create, read, update, and delete student entries, plus retrieve a count of how many records exist.
### Features
User authentication (signup/login)
JWT-based authentication
Full CRUD operations for student records
Password update functionality
Pagination for student listings
MongoDB database integration
## API Endpoints
### Authentication
POST /signup - Create a new user account
POST /login - Authenticate and receive an access token
### Student Operations:
- GET /students - Get all students (with optional pagination ?page=1)
- GET /students?page=1 - Pagination query
- GET /students/:id - Get a specific student by ID
- PATCH /students/:id - Update student information
- PATCH /students/:id/password - Update student password
- DELETE /students/:id - Delete a student record
## Getting Started
Prerequisites
- Node.js (v14 or later)
- MongoDB (v4 or later)
- npm or yarn
## Technologies Used
- Node.js
- Express.js
- MongoDB
- Mongoose (ODM)
- JWT (JSON Web Tokens for authentication)
- Bcrypt (password hashing)
## Installation
1. Clone the repository:
- git clone https://github.com/mrchukwu/student_records_api.git
- cd student-records-api
2. Install dependencies
- npm install