https://github.com/mrchukwu/student_records_api
RESTful student API service
https://github.com/mrchukwu/student_records_api
cookie-parser cursor dotenv express git javascript jsonwebtoken mongodb mongoose mvc-architecture nodejs npm restful-api validator
Last synced: about 2 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 (12 months ago)
- Default Branch: main
- Last Pushed: 2025-06-30T23:08:26.000Z (12 months ago)
- Last Synced: 2026-04-30T20:32:11.306Z (about 2 months ago)
- Topics: cookie-parser, cursor, dotenv, express, git, javascript, jsonwebtoken, mongodb, mongoose, mvc-architecture, nodejs, npm, restful-api, validator
- Language: JavaScript
- Homepage:
- Size: 71.3 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# STUDENT RECORD API
- The Student Record REST API is a simple, secure, and scalable API that enables you to manage student records stored in a MongoDB database. It supports basic CRUD operations along with authentication and pagination features. This API is built using Node.js, Express.js, and MongoDB (via Mongoose), supporting full student lifecycle management including authentication, profile updates, and status tracking (present, absent, suspended, expelled).
This API allows developers or administrators to:
- Register new students
- Log in and authenticate students
- View, update, and delete student records
- Track student attendance status (present, absent, suspended, expelled)
- Securely update passwords
- Manage sessions with login/logout functionality
### 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 - Get students count
- 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