Student Management System API

A comprehensive Django REST Framework-based API for managing educational institution data including students, teachers, courses, departments, and enrollments.

Features

Department Management: Create and manage academic departments
Student Management: Complete student information system with filtering and search
Teacher Management: Manage faculty information
Course Management: Handle course catalog and details
Enrollment System: Track student course enrollments
REST API: Full CRUD operations for all resources
Pagination: Built-in pagination support
Filtering & Search: Advanced filtering and search capabilities
Admin Interface: Django admin panel for easy management

Tech Stack

Framework: Django 5.2.8
API: Django REST Framework
Database: SQLite (default)
Python: 3.x

Installation

Prerequisites

Python 3.x installed
pip package manager

Setup Steps

Clone the repository

git clone <repository-url>
cd students

Create a virtual environment

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

Install dependencies

pip install django djangorestframework django-filter

Run migrations

python manage.py migrate

Create a superuser

python manage.py createsuperuser

Run the development server

python manage.py runserver

The API will be available at http://127.0.0.1:8000/

API Endpoints

Base URL: `/api/`

Departments

GET /api/department/ - List all departments
POST /api/department/ - Create new department
GET /api/department/{id}/ - Retrieve department details
PUT /api/department/{id}/ - Update department
PATCH /api/department/{id}/ - Partial update department
DELETE /api/department/{id}/ - Delete department

Students

GET /api/students/ - List all students
POST /api/students/ - Create new student
GET /api/students/{id}/ - Retrieve student details
PATCH /api/students/{id}/ - Update student
DELETE /api/students/{id}/ - Delete student

Query Parameters:

search - Search by name, student_id, email, phone, address, gender, dob, admission_date
ordering - Order by name
department - Filter by department ID
gender - Filter by gender (male/female)
limit - Pagination limit
offset - Pagination offset

Teachers

GET /api/teachers/ - List all teachers
POST /api/teachers/ - Create new teacher
GET /api/teachers/{id}/ - Retrieve teacher details
PATCH /api/teachers/{id}/ - Update teacher
DELETE /api/teachers/{id}/ - Delete teacher

Courses

GET /api/courses/ - List all courses
POST /api/courses/ - Create new course
GET /api/courses/{id}/ - Retrieve course details
PUT /api/courses/{id}/ - Update course
PATCH /api/courses/{id}/ - Update course partially
DELETE /api/courses/{id}/ - Delete course

Enrollments

GET /api/enrollments/ - List all enrollments
POST /api/enrollments/ - Create new enrollment
GET /api/enrollments/{id}/ - Retrieve enrollment details
PATCH /api/enrollments/{id}/ - Update enrollment
DELETE /api/enrollments/{id}/ - Delete enrollment

Query Parameters:

search - Search by student ID, course ID, enrollment_date
ordering - Order by enrollment_date, student__id, course__id
student - Filter by student ID
course__title - Filter by course title
limit - Pagination limit
offset - Pagination offset

Data Models

Department

{
    "id": integer,
    "name": string,
    "code": string,
    "description": string (optional)
}

Student

{
    "id": integer,
    "name": string,
    "student_id": string (unique),
    "email": string (unique),
    "phone": string (optional),
    "address": string (optional),
    "gender": "male" | "female",
    "dob": date (optional),
    "admission_date": date (optional),
    "department": integer (foreign key),
    "created_at": datetime,
    "updated_at": datetime
}

Teacher

{
    "id": integer,
    "name": string,
    "teacher_id": string (unique),
    "designation": string,
    "email": string (unique),
    "phone": string (optional),
    "address": string (optional),
    "department": integer (foreign key),
    "created_at": datetime
}

Course

{
    "id": integer,
    "title": string,
    "code": string (unique),
    "credit": decimal,
    "semester": integer,
    "department": integer (foreign key),
    "created_at": datetime,
    "updated_at": datetime
}

Enrollment

{
    "id": integer,
    "student": integer (foreign key),
    "course": integer (foreign key),
    "enrollment_date": date (optional),
    "student_name": string (write-only),
    "course_name": string (write-only),
    "created_at": datetime,
    "updated_at": datetime
}

Usage Examples

Create a Department

curl -X POST http://127.0.0.1:8000/api/department/ \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Computer Science",
    "code": "CSE",
    "description": "Department of Computer Science and Engineering"
  }'

Create a Student

curl -X POST http://127.0.0.1:8000/api/students/ \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "student_id": "2024001",
    "email": "john@example.com",
    "gender": "male",
    "department": 1
  }'

Search Students

curl "http://127.0.0.1:8000/api/students/?search=John&department=1"

Create an Enrollment

curl -X POST http://127.0.0.1:8000/api/enrollments/ \
  -H "Content-Type: application/json" \
  -d '{
    "student_name": "John Doe",
    "course_name": "Data Structures",
    "enrollment_date": "2024-01-15"
  }'

Admin Panel

Access the Django admin panel at http://127.0.0.1:8000/admin/ using your superuser credentials.

The admin interface provides:

Visual management of all models
Search and filter capabilities
Bulk operations
Data validation

Project Structure

students/
├── api/
│   ├── migrations/
│   ├── __init__.py
│   ├── admin.py          # Admin configurations
│   ├── apps.py
│   ├── models.py         # Database models
│   ├── serializers.py    # DRF serializers
│   ├── views.py          # API viewsets
│   └── urls.py           # API URL routing
├── students/
│   ├── __init__.py
│   ├── settings.py       # Project settings
│   ├── urls.py           # Main URL configuration
│   ├── wsgi.py
│   └── asgi.py
├── manage.py
└── db.sqlite3

Configuration

Settings (`students/settings.py`)

Key configurations:

DEBUG = True - Development mode (set to False in production)
ALLOWED_HOSTS = [] - Add your domain in production
DATABASES - Currently using SQLite, can be changed to PostgreSQL/MySQL

Installed Apps

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'rest_framework',
    'api',
]

Known Issues

Teacher model has a syntax error with a comma after updated_at field
CoursesViewset.destroy() has a typo: course.detele() should be course.delete()
TeachersViewset.destroy() returns status 2024 instead of 204
Commented out create and update methods in EnrollmentsSerializer

Future Enhancements

Add authentication and authorization
Implement grading system
Add attendance tracking
Generate reports and analytics
Add file upload for student/teacher photos
Implement email notifications
Add more advanced filtering options

Contributing

Fork the repository
Create a feature branch
Commit your changes
Push to the branch
Create a Pull Request

License

This project is open source and available under the MIT License.

Support

For issues and questions, please create an issue in the repository or contact the development team.

Note: This is a development version. Please configure proper security settings, use environment variables for sensitive data, and set up a production-grade database before deploying to production.

Name		Name	Last commit message	Last commit date
Latest commit History 46 Commits
api		api
attendance		attendance
courses		courses
departments		departments
enrollments		enrollments
results		results
students		students
teachers		teachers
users		users
README.md		README.md
db.sqlite3		db.sqlite3
manage.py		manage.py
students_demo.json		students_demo.json

MNR-Tushar/student_management_system_api

Folders and files

Latest commit

History

Repository files navigation