huge update
This commit is contained in:
1 parent
f2c72885a6
commit
a4f8b3594e
1 file changed
+109
-79
@@ -21,7 +21,6 @@ A comprehensive Student Management System built with Django, featuring multi-rol
|
|||||||
- [👥 Role System](#-role-system)
|
- [👥 Role System](#-role-system)
|
||||||
- [✨ Key Features](#-key-features)
|
- [✨ Key Features](#-key-features)
|
||||||
- [🎯 Project Architecture](#-project-architecture)
|
- [🎯 Project Architecture](#-project-architecture)
|
||||||
- [💰 Project Costs](#-project-costs)
|
|
||||||
- [🌍 Feasibility](#-feasibility)
|
- [🌍 Feasibility](#-feasibility)
|
||||||
- [🚀 Getting Started](#-getting-started)
|
- [🚀 Getting Started](#-getting-started)
|
||||||
- [🔧 Configuration](#-configuration)
|
- [🔧 Configuration](#-configuration)
|
||||||
@@ -42,69 +41,70 @@ A comprehensive Student Management System built with Django, featuring multi-rol
|
|||||||
<details>
|
<details>
|
||||||
<summary><b>🔥 Core Technologies</b></summary>
|
<summary><b>🔥 Core Technologies</b></summary>
|
||||||
|
|
||||||
| Technology | Version | Purpose | Documentation |
|
| Technology | Version | Purpose | Documentation |
|
||||||
|------------|---------|---------|---------------|
|
| --------------------- | ------- | ------------------- | -------------------------------------------------- |
|
||||||
| Python | 3.8+ | Backend Development | [Python Docs](https://docs.python.org/) |
|
| Python | 3.8+ | Backend Development | [Python Docs](https://docs.python.org/) |
|
||||||
| Django | 5.2 | Web Framework | [Django Docs](https://docs.djangoproject.com/) |
|
| Django | 5.2 | Web Framework | [Django Docs](https://docs.djangoproject.com/) |
|
||||||
| Django REST Framework | 3.16.0 | API Development | [DRF Docs](https://www.django-rest-framework.org/) |
|
| Django REST Framework | 3.16.0 | API Development | [DRF Docs](https://www.django-rest-framework.org/) |
|
||||||
| Firebase Admin | 6.7.0 | Real-time Features | [Firebase Docs](https://firebase.google.com/docs) |
|
| Firebase Admin | 6.7.0 | Real-time Features | [Firebase Docs](https://firebase.google.com/docs) |
|
||||||
| Google Cloud Storage | 3.1.0 | File Storage | [GCS Docs](https://cloud.google.com/storage/docs) |
|
| Google Cloud Storage | 3.1.0 | File Storage | [GCS Docs](https://cloud.google.com/storage/docs) |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary><b>⚡ Frontend Technologies</b></summary>
|
<summary><b>⚡ Frontend Technologies</b></summary>
|
||||||
|
|
||||||
| Technology | Version | Purpose | Documentation |
|
| Technology | Version | Purpose | Documentation |
|
||||||
|------------|---------|---------|---------------|
|
| ---------------- | ------- | ----------------- | --------------------------------------------------------- |
|
||||||
| Bootstrap | 5.3.0 | UI Framework | [Bootstrap Docs](https://getbootstrap.com/docs/) |
|
| Bootstrap | 5.3.0 | UI Framework | [Bootstrap Docs](https://getbootstrap.com/docs/) |
|
||||||
| jQuery | Latest | DOM Manipulation | [jQuery Docs](https://api.jquery.com/) |
|
| jQuery | Latest | DOM Manipulation | [jQuery Docs](https://api.jquery.com/) |
|
||||||
| Firebase Web SDK | 9.22.0 | Real-time Updates | [Firebase Web Docs](https://firebase.google.com/docs/web) |
|
| Firebase Web SDK | 9.22.0 | Real-time Updates | [Firebase Web Docs](https://firebase.google.com/docs/web) |
|
||||||
| Font Awesome | 6.0.0 | Icons | [Font Awesome Docs](https://fontawesome.com/docs) |
|
| Font Awesome | 6.0.0 | Icons | [Font Awesome Docs](https://fontawesome.com/docs) |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary><b>🛠️ Development Tools</b></summary>
|
<summary><b>🛠️ Development Tools</b></summary>
|
||||||
|
|
||||||
| Tool | Version | Purpose | Documentation |
|
| Tool | Version | Purpose | Documentation |
|
||||||
|------|---------|---------|---------------|
|
| ------------------ | ------- | ------------------- | --------------------------------------------------------------- |
|
||||||
| Git | Latest | Version Control | [Git Docs](https://git-scm.com/doc) |
|
| Git | Latest | Version Control | [Git Docs](https://git-scm.com/doc) |
|
||||||
| WhiteNoise | 6.9.0 | Static File Serving | [WhiteNoise Docs](https://whitenoise.readthedocs.io/) |
|
| WhiteNoise | 6.9.0 | Static File Serving | [WhiteNoise Docs](https://whitenoise.readthedocs.io/) |
|
||||||
| PyOTP | 2.9.0 | OTP Generation | [PyOTP Docs](https://github.com/pyauth/pyotp) |
|
| PyOTP | 2.9.0 | OTP Generation | [PyOTP Docs](https://github.com/pyauth/pyotp) |
|
||||||
| Django Jazzmin | 3.0.1 | Admin Interface | [Jazzmin Docs](https://django-jazzmin.readthedocs.io/) |
|
| Django Jazzmin | 3.0.1 | Admin Interface | [Jazzmin Docs](https://django-jazzmin.readthedocs.io/) |
|
||||||
| Django Mathfilters | 1.0.0 | Math Operations | [Mathfilters Docs](https://github.com/dbrgn/django-mathfilters) |
|
| Django Mathfilters | 1.0.0 | Math Operations | [Mathfilters Docs](https://github.com/dbrgn/django-mathfilters) |
|
||||||
| Django Model Utils | 5.0.0 | Model Utilities | [Model Utils Docs](https://django-model-utils.readthedocs.io/) |
|
| Django Model Utils | 5.0.0 | Model Utilities | [Model Utils Docs](https://django-model-utils.readthedocs.io/) |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
### 🖥️ Development Environment
|
### 🖥️ Development Environment
|
||||||
|
|
||||||
| Component | Details |
|
| Component | Details |
|
||||||
|-----------|---------|
|
| -------------------- | ---------------------------------------------- |
|
||||||
| **Operating System** | [Arch Linux](https://archlinux.org/) |
|
| **Operating System** | [Arch Linux](https://archlinux.org/) |
|
||||||
| **Window Manager** | [Hyprland](https://github.com/hyprwm/Hyprland) |
|
| **Window Manager** | [Hyprland](https://github.com/hyprwm/Hyprland) |
|
||||||
| **Status Bar** | [Modus](https://github.com/S4NKALP/Modus) |
|
| **Status Bar** | [Modus](https://github.com/S4NKALP/Modus) |
|
||||||
| **Editor** | [Neovim](https://neovim.io/) |
|
| **Editor** | [Neovim](https://neovim.io/) |
|
||||||
| **Terminal** | [Kitty](https://sw.kovidgoyal.net/kitty/) |
|
| **Terminal** | [Kitty](https://sw.kovidgoyal.net/kitty/) |
|
||||||
| **Shell** | [Zsh](https://www.zsh.org/) |
|
| **Shell** | [Zsh](https://www.zsh.org/) |
|
||||||
|
|
||||||
## 👥 Role System
|
## 👥 Role System
|
||||||
|
|
||||||
### 🎓 User Roles and Permissions
|
### 🎓 User Roles and Permissions
|
||||||
|
|
||||||
| Role | Description | Key Features |
|
| Role | Description | Key Features |
|
||||||
|------|-------------|--------------|
|
| ---------------------------- | ---------------------------------------- | -------------------------------------------------------------------------------- |
|
||||||
| **Super Admin** | System administrator with full access | - Full system control<br>- User management<br>- System configuration |
|
| **Super Admin** | System administrator with full access | - Full system control<br>- User management<br>- System configuration |
|
||||||
| **HOD (Head of Department)** | Department head with elevated privileges | - Course management<br>- Staff supervision<br>- Department analytics |
|
| **HOD (Head of Department)** | Department head with elevated privileges | - Course management<br>- Staff supervision<br>- Department analytics |
|
||||||
| **Admission Officer** | Handles student admissions | - Student registration<br>- Document verification<br>- Admission tracking |
|
| **Admission Officer** | Handles student admissions | - Student registration<br>- Document verification<br>- Admission tracking |
|
||||||
| **Teacher** | Academic staff member | - Class management<br>- Attendance tracking<br>- Grade management |
|
| **Teacher** | Academic staff member | - Class management<br>- Attendance tracking<br>- Grade management |
|
||||||
| **Student** | Primary system user | - Course access<br>- Attendance tracking<br>- Grade viewing |
|
| **Student** | Primary system user | - Course access<br>- Attendance tracking<br>- Grade viewing |
|
||||||
| **Parent** | Student guardian | - Student progress tracking<br>- Communication with teachers<br>- Fee management |
|
| **Parent** | Student guardian | - Student progress tracking<br>- Communication with teachers<br>- Fee management |
|
||||||
|
|
||||||
### 🔐 Authentication System
|
### 🔐 Authentication System
|
||||||
|
|
||||||
- **Multi-factor Authentication**
|
- **Multi-factor Authentication**
|
||||||
|
|
||||||
- Phone-based OTP verification
|
- Phone-based OTP verification
|
||||||
- TOTP (Time-based One-Time Password)
|
- TOTP (Time-based One-Time Password)
|
||||||
- Password reset tokens
|
- Password reset tokens
|
||||||
@@ -119,12 +119,14 @@ A comprehensive Student Management System built with Django, featuring multi-rol
|
|||||||
## ✨ Key Features
|
## ✨ Key Features
|
||||||
|
|
||||||
### 👥 User Management
|
### 👥 User Management
|
||||||
|
|
||||||
- **Multi-role System**: Comprehensive role hierarchy
|
- **Multi-role System**: Comprehensive role hierarchy
|
||||||
- **Secure Authentication**: OTP and TOTP-based verification
|
- **Secure Authentication**: OTP and TOTP-based verification
|
||||||
- **Role-based Access Control**: Detailed permission system
|
- **Role-based Access Control**: Detailed permission system
|
||||||
- **User Profiles**: Complete user information management
|
- **User Profiles**: Complete user information management
|
||||||
|
|
||||||
### 📚 Academic Management
|
### 📚 Academic Management
|
||||||
|
|
||||||
- **Course Management**: Create and manage courses
|
- **Course Management**: Create and manage courses
|
||||||
- **Subject Management**: Organize subjects with materials
|
- **Subject Management**: Organize subjects with materials
|
||||||
- **Class Scheduling**: Advanced timetable system
|
- **Class Scheduling**: Advanced timetable system
|
||||||
@@ -132,36 +134,42 @@ A comprehensive Student Management System built with Django, featuring multi-rol
|
|||||||
- **Exam Management**: Complete exam workflow
|
- **Exam Management**: Complete exam workflow
|
||||||
|
|
||||||
### 📊 Attendance System
|
### 📊 Attendance System
|
||||||
|
|
||||||
- **Real-time Tracking**: Live attendance monitoring
|
- **Real-time Tracking**: Live attendance monitoring
|
||||||
- **Automated Reports**: Detailed attendance analytics
|
- **Automated Reports**: Detailed attendance analytics
|
||||||
- **Notification System**: Real-time alerts
|
- **Notification System**: Real-time alerts
|
||||||
- **Bulk Operations**: Efficient batch processing
|
- **Bulk Operations**: Efficient batch processing
|
||||||
|
|
||||||
### 📝 Leave Management
|
### 📝 Leave Management
|
||||||
|
|
||||||
- **Multi-level Approval**: Role-based approval workflow
|
- **Multi-level Approval**: Role-based approval workflow
|
||||||
- **Leave History**: Complete leave tracking
|
- **Leave History**: Complete leave tracking
|
||||||
- **Automated Notifications**: Status updates
|
- **Automated Notifications**: Status updates
|
||||||
- **Documentation**: Leave record management
|
- **Documentation**: Leave record management
|
||||||
|
|
||||||
### 👨👩👧👦 Parent-Teacher Interaction
|
### 👨👩👧👦 Parent-Teacher Interaction
|
||||||
|
|
||||||
- **Meeting Scheduling**: Online/offline meeting management
|
- **Meeting Scheduling**: Online/offline meeting management
|
||||||
- **Progress Tracking**: Student performance monitoring
|
- **Progress Tracking**: Student performance monitoring
|
||||||
- **Communication**: Direct messaging system
|
- **Communication**: Direct messaging system
|
||||||
- **Feedback System**: Comprehensive feedback mechanism
|
- **Feedback System**: Comprehensive feedback mechanism
|
||||||
|
|
||||||
### 📈 Course Progress Tracking
|
### 📈 Course Progress Tracking
|
||||||
|
|
||||||
- **Progress Monitoring**: Real-time course progress
|
- **Progress Monitoring**: Real-time course progress
|
||||||
- **Completion Tracking**: Detailed completion metrics
|
- **Completion Tracking**: Detailed completion metrics
|
||||||
- **Performance Analytics**: Student performance analysis
|
- **Performance Analytics**: Student performance analysis
|
||||||
- **Automated Updates**: Progress notifications
|
- **Automated Updates**: Progress notifications
|
||||||
|
|
||||||
### 🔄 Feedback System
|
### 🔄 Feedback System
|
||||||
|
|
||||||
- **Multi-level Feedback**: Student, parent, and staff feedback
|
- **Multi-level Feedback**: Student, parent, and staff feedback
|
||||||
- **Rating System**: Detailed rating mechanism
|
- **Rating System**: Detailed rating mechanism
|
||||||
- **Anonymous Feedback**: Option for anonymous submissions
|
- **Anonymous Feedback**: Option for anonymous submissions
|
||||||
- **Feedback Analytics**: Comprehensive feedback analysis
|
- **Feedback Analytics**: Comprehensive feedback analysis
|
||||||
|
|
||||||
### 🔐 Security Features
|
### 🔐 Security Features
|
||||||
|
|
||||||
- **OTP Verification**: Two-factor authentication
|
- **OTP Verification**: Two-factor authentication
|
||||||
- **Session Management**: Secure session handling
|
- **Session Management**: Secure session handling
|
||||||
- **CSRF Protection**: Cross-site request forgery prevention
|
- **CSRF Protection**: Cross-site request forgery prevention
|
||||||
@@ -169,6 +177,7 @@ A comprehensive Student Management System built with Django, featuring multi-rol
|
|||||||
- **SQL Injection Prevention**: Secure database queries
|
- **SQL Injection Prevention**: Secure database queries
|
||||||
|
|
||||||
### 📱 Mobile Features
|
### 📱 Mobile Features
|
||||||
|
|
||||||
- **Responsive Design**: Mobile-first approach
|
- **Responsive Design**: Mobile-first approach
|
||||||
- **Push Notifications**: Real-time updates
|
- **Push Notifications**: Real-time updates
|
||||||
- **Offline Support**: Basic functionality without internet
|
- **Offline Support**: Basic functionality without internet
|
||||||
@@ -196,24 +205,28 @@ SMS/
|
|||||||
## 🔄 Recent Improvements
|
## 🔄 Recent Improvements
|
||||||
|
|
||||||
### 🧹 Code Reorganization
|
### 🧹 Code Reorganization
|
||||||
|
|
||||||
- **Reduced Redundancy**: Consolidated duplicate code in view functions
|
- **Reduced Redundancy**: Consolidated duplicate code in view functions
|
||||||
- **Improved Structure**: Created common view utilities and helper functions
|
- **Improved Structure**: Created common view utilities and helper functions
|
||||||
- **Better Code Reuse**: Implemented common handlers for common operations
|
- **Better Code Reuse**: Implemented common handlers for common operations
|
||||||
- **Standardized Response Format**: Created consistent API response formats
|
- **Standardized Response Format**: Created consistent API response formats
|
||||||
|
|
||||||
### ⚡ Performance Optimizations
|
### ⚡ Performance Optimizations
|
||||||
|
|
||||||
- **Dependency Management**: Updated and optimized package requirements
|
- **Dependency Management**: Updated and optimized package requirements
|
||||||
- **Firebase Integration**: Enhanced Firebase functionality and error handling
|
- **Firebase Integration**: Enhanced Firebase functionality and error handling
|
||||||
- **View Efficiency**: Reduced redundant database queries
|
- **View Efficiency**: Reduced redundant database queries
|
||||||
- **API Improvements**: Standardized API response formats for better client handling
|
- **API Improvements**: Standardized API response formats for better client handling
|
||||||
|
|
||||||
### 🔧 Technical Enhancements
|
### 🔧 Technical Enhancements
|
||||||
|
|
||||||
- **Role-based Access**: Improved role verification with utility functions
|
- **Role-based Access**: Improved role verification with utility functions
|
||||||
- **Error Handling**: Better error detection and user feedback
|
- **Error Handling**: Better error detection and user feedback
|
||||||
- **File Upload Handling**: Centralized file upload handling with validation
|
- **File Upload Handling**: Centralized file upload handling with validation
|
||||||
- **Password Security**: Enhanced password strength validation
|
- **Password Security**: Enhanced password strength validation
|
||||||
|
|
||||||
### 🧹 Code Cleanup
|
### 🧹 Code Cleanup
|
||||||
|
|
||||||
- **Removed Print Statements**: Eliminated unnecessary print debug statements
|
- **Removed Print Statements**: Eliminated unnecessary print debug statements
|
||||||
- **Standardized Views**: Consistent view behavior across the application
|
- **Standardized Views**: Consistent view behavior across the application
|
||||||
- **Simplified Middleware**: Streamlined HTTP error handling
|
- **Simplified Middleware**: Streamlined HTTP error handling
|
||||||
@@ -226,6 +239,7 @@ These improvements make the codebase more maintainable, easier to extend, and mo
|
|||||||
### 📋 Prerequisites
|
### 📋 Prerequisites
|
||||||
|
|
||||||
Before you begin, ensure you have the following installed:
|
Before you begin, ensure you have the following installed:
|
||||||
|
|
||||||
- [Python](https://www.python.org/downloads/) (3.8 or higher)
|
- [Python](https://www.python.org/downloads/) (3.8 or higher)
|
||||||
- [Git](https://git-scm.com/downloads)
|
- [Git](https://git-scm.com/downloads)
|
||||||
- [Firebase Account](https://firebase.google.com/) (for notifications)
|
- [Firebase Account](https://firebase.google.com/) (for notifications)
|
||||||
@@ -234,6 +248,7 @@ Before you begin, ensure you have the following installed:
|
|||||||
### 🛠️ Installation Steps
|
### 🛠️ Installation Steps
|
||||||
|
|
||||||
#### 1️⃣ Clone the Repository
|
#### 1️⃣ Clone the Repository
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Clone the repository
|
# Clone the repository
|
||||||
git clone https://github.com/S4NKALP/Student-Management-System-In-Django.git
|
git clone https://github.com/S4NKALP/Student-Management-System-In-Django.git
|
||||||
@@ -243,6 +258,7 @@ cd Student-Management-System-In-Django
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### 2️⃣ Set Up Virtual Environment
|
#### 2️⃣ Set Up Virtual Environment
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Create a virtual environment
|
# Create a virtual environment
|
||||||
python -m venv venv
|
python -m venv venv
|
||||||
@@ -256,12 +272,14 @@ source venv/bin/activate
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### 3️⃣ Install Dependencies
|
#### 3️⃣ Install Dependencies
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Install Python dependencies
|
# Install Python dependencies
|
||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 4️⃣ Configure Environment Variables
|
#### 4️⃣ Configure Environment Variables
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Copy the example environment file
|
# Copy the example environment file
|
||||||
cp .env.example .env
|
cp .env.example .env
|
||||||
@@ -276,6 +294,7 @@ cp .env.example .env
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### 5️⃣ Set Up Firebase
|
#### 5️⃣ Set Up Firebase
|
||||||
|
|
||||||
1. Go to [Firebase Console](https://console.firebase.google.com/)
|
1. Go to [Firebase Console](https://console.firebase.google.com/)
|
||||||
2. Create a new project or select an existing one
|
2. Create a new project or select an existing one
|
||||||
3. Enable the following services:
|
3. Enable the following services:
|
||||||
@@ -285,6 +304,7 @@ cp .env.example .env
|
|||||||
- Cloud Messaging
|
- Cloud Messaging
|
||||||
|
|
||||||
#### 2️⃣ Service Account Key (`firebase-key.json`)
|
#### 2️⃣ Service Account Key (`firebase-key.json`)
|
||||||
|
|
||||||
1. In Firebase Console, go to Project Settings > Service Accounts
|
1. In Firebase Console, go to Project Settings > Service Accounts
|
||||||
2. Click "Generate New Private Key"
|
2. Click "Generate New Private Key"
|
||||||
3. Save the downloaded JSON file as `firebase-key.json` in your project root
|
3. Save the downloaded JSON file as `firebase-key.json` in your project root
|
||||||
@@ -294,7 +314,9 @@ cp .env.example .env
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### 3️⃣ Firebase Configuration Files
|
#### 3️⃣ Firebase Configuration Files
|
||||||
|
|
||||||
1. Copy the example files and rename them:
|
1. Copy the example files and rename them:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Copy Firebase config example
|
# Copy Firebase config example
|
||||||
cp static/js/firebase-config.example.js static/js/firebase-config.js
|
cp static/js/firebase-config.example.js static/js/firebase-config.js
|
||||||
@@ -309,6 +331,7 @@ cp .env.example .env
|
|||||||
- Replace other placeholder values with your actual Firebase configuration
|
- Replace other placeholder values with your actual Firebase configuration
|
||||||
|
|
||||||
#### 4️⃣ Firebase Cloud Messaging (FCM) Setup
|
#### 4️⃣ Firebase Cloud Messaging (FCM) Setup
|
||||||
|
|
||||||
1. In Firebase Console, go to Project Settings > Cloud Messaging
|
1. In Firebase Console, go to Project Settings > Cloud Messaging
|
||||||
2. Generate a new Server Key
|
2. Generate a new Server Key
|
||||||
3. Add the key to your `.env` file:
|
3. Add the key to your `.env` file:
|
||||||
@@ -317,6 +340,7 @@ cp .env.example .env
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### 5️⃣ Testing Firebase Setup
|
#### 5️⃣ Testing Firebase Setup
|
||||||
|
|
||||||
1. Run the development server
|
1. Run the development server
|
||||||
2. Open the browser console
|
2. Open the browser console
|
||||||
3. Check for any Firebase-related errors
|
3. Check for any Firebase-related errors
|
||||||
@@ -325,12 +349,14 @@ cp .env.example .env
|
|||||||
### 📱 Accessing the Application
|
### 📱 Accessing the Application
|
||||||
|
|
||||||
Once everything is set up, you can access:
|
Once everything is set up, you can access:
|
||||||
|
|
||||||
- **Admin Panel**: http://localhost:8000/admin
|
- **Admin Panel**: http://localhost:8000/admin
|
||||||
- **Main Application**: http://localhost:8000
|
- **Main Application**: http://localhost:8000
|
||||||
|
|
||||||
### 🚨 Troubleshooting Guide
|
### 🚨 Troubleshooting Guide
|
||||||
|
|
||||||
#### 🔧 Common Issues
|
#### 🔧 Common Issues
|
||||||
|
|
||||||
- **Firebase Setup**: Ensure proper configuration in `firebase-config.js` and `firebase-key.json`
|
- **Firebase Setup**: Ensure proper configuration in `firebase-config.js` and `firebase-key.json`
|
||||||
- **Static Files**: Run `python manage.py collectstatic` if static files are not loading
|
- **Static Files**: Run `python manage.py collectstatic` if static files are not loading
|
||||||
- **Database Issues**: Check database settings in `.env` file
|
- **Database Issues**: Check database settings in `.env` file
|
||||||
@@ -339,7 +365,9 @@ Once everything is set up, you can access:
|
|||||||
## 🔧 Configuration
|
## 🔧 Configuration
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
|
|
||||||
Create a `.env` file in the project root:
|
Create a `.env` file in the project root:
|
||||||
|
|
||||||
```env
|
```env
|
||||||
# Django Settings
|
# Django Settings
|
||||||
DEBUG=True
|
DEBUG=True
|
||||||
@@ -378,6 +406,7 @@ OTP_EXPIRY=300 # OTP expiry time in seconds
|
|||||||
## 📦 Dependencies
|
## 📦 Dependencies
|
||||||
|
|
||||||
### Backend
|
### Backend
|
||||||
|
|
||||||
- Django 5.2
|
- Django 5.2
|
||||||
- Django REST Framework 3.16.0
|
- Django REST Framework 3.16.0
|
||||||
- Firebase Admin 6.7.0
|
- Firebase Admin 6.7.0
|
||||||
@@ -389,6 +418,7 @@ OTP_EXPIRY=300 # OTP expiry time in seconds
|
|||||||
- Django Model Utils 5.0.0
|
- Django Model Utils 5.0.0
|
||||||
|
|
||||||
### Frontend
|
### Frontend
|
||||||
|
|
||||||
- Bootstrap 5.3.0
|
- Bootstrap 5.3.0
|
||||||
- jQuery Latest
|
- jQuery Latest
|
||||||
- Firebase Web SDK 9.22.0
|
- Firebase Web SDK 9.22.0
|
||||||
@@ -397,12 +427,14 @@ OTP_EXPIRY=300 # OTP expiry time in seconds
|
|||||||
## 🔐 Security Features
|
## 🔐 Security Features
|
||||||
|
|
||||||
### Authentication
|
### Authentication
|
||||||
|
|
||||||
- OTP and TOTP-based authentication
|
- OTP and TOTP-based authentication
|
||||||
- Session management
|
- Session management
|
||||||
- Password hashing
|
- Password hashing
|
||||||
- Password reset tokens
|
- Password reset tokens
|
||||||
|
|
||||||
### Data Protection
|
### Data Protection
|
||||||
|
|
||||||
- CSRF protection
|
- CSRF protection
|
||||||
- XSS prevention
|
- XSS prevention
|
||||||
- SQL injection prevention
|
- SQL injection prevention
|
||||||
@@ -414,38 +446,48 @@ OTP_EXPIRY=300 # OTP expiry time in seconds
|
|||||||
### Core Models
|
### Core Models
|
||||||
|
|
||||||
#### Institute
|
#### Institute
|
||||||
|
|
||||||
- `name`, `phone`, `email`, `address`, `pan_no`, `reg_no`, `logo`, `description`
|
- `name`, `phone`, `email`, `address`, `pan_no`, `reg_no`, `logo`, `description`
|
||||||
|
|
||||||
#### Course
|
#### Course
|
||||||
|
|
||||||
- `name`, `code`, `duration`, `duration_type`, `description`, `is_active`
|
- `name`, `code`, `duration`, `duration_type`, `description`, `is_active`
|
||||||
|
|
||||||
#### Subject
|
#### Subject
|
||||||
|
|
||||||
- `name`, `code`, `course`, `period_or_year`, `syllabus_pdf`, `files`
|
- `name`, `code`, `course`, `period_or_year`, `syllabus_pdf`, `files`
|
||||||
|
|
||||||
#### Student
|
#### Student
|
||||||
|
|
||||||
- `name`, `status`, `gender`, `birth_date`, `email`, `phone`, `addresses`
|
- `name`, `status`, `gender`, `birth_date`, `email`, `phone`, `addresses`
|
||||||
- `marital_status`, `parent_name`, `parent_phone`, `citizenship_no`
|
- `marital_status`, `parent_name`, `parent_phone`, `citizenship_no`
|
||||||
- `batches`, `image`, `course`, `current_period`, `joining_date`, `fcm_token`
|
- `batches`, `image`, `course`, `current_period`, `joining_date`, `fcm_token`
|
||||||
|
|
||||||
#### Staff
|
#### Staff
|
||||||
|
|
||||||
- `name`, `phone`, `designation`, `gender`, `birth_date`, `email`, `addresses`
|
- `name`, `phone`, `designation`, `gender`, `birth_date`, `email`, `addresses`
|
||||||
- `marital_status`, `parent_name`, `parent_phone`, `citizenship_no`, `passport`
|
- `marital_status`, `parent_name`, `parent_phone`, `citizenship_no`, `passport`
|
||||||
- `image`, `joining_date`, `fcm_token`, `course`
|
- `image`, `joining_date`, `fcm_token`, `course`
|
||||||
|
|
||||||
#### Parent
|
#### Parent
|
||||||
|
|
||||||
- `name`, `phone`, `email`, `address`, `students`, `image`, `fcm_token`
|
- `name`, `phone`, `email`, `address`, `students`, `image`, `fcm_token`
|
||||||
|
|
||||||
#### Routine
|
#### Routine
|
||||||
|
|
||||||
- `course`, `subject`, `teacher`, `start_time`, `end_time`, `period_or_year`, `is_active`
|
- `course`, `subject`, `teacher`, `start_time`, `end_time`, `period_or_year`, `is_active`
|
||||||
|
|
||||||
#### Attendance
|
#### Attendance
|
||||||
|
|
||||||
- `date`, `routine`, `teacher`, `teacher_attend`, `class_status`
|
- `date`, `routine`, `teacher`, `teacher_attend`, `class_status`
|
||||||
|
|
||||||
#### Leave Management
|
#### Leave Management
|
||||||
|
|
||||||
- `StaffLeave`: `staff`, `start_date`, `end_date`, `message`, `status`
|
- `StaffLeave`: `staff`, `start_date`, `end_date`, `message`, `status`
|
||||||
- `StudentLeave`: `student`, `start_date`, `end_date`, `message`, `status`
|
- `StudentLeave`: `student`, `start_date`, `end_date`, `message`, `status`
|
||||||
|
|
||||||
#### Feedback System
|
#### Feedback System
|
||||||
|
|
||||||
- `StudentFeedback`: Student feedback for teachers
|
- `StudentFeedback`: Student feedback for teachers
|
||||||
- `ParentFeedback`: Parent feedback for teachers
|
- `ParentFeedback`: Parent feedback for teachers
|
||||||
- `InstituteFeedback`: Student feedback for institute
|
- `InstituteFeedback`: Student feedback for institute
|
||||||
@@ -453,21 +495,25 @@ OTP_EXPIRY=300 # OTP expiry time in seconds
|
|||||||
- `ParentInstituteFeedback`: Parent feedback for institute
|
- `ParentInstituteFeedback`: Parent feedback for institute
|
||||||
|
|
||||||
#### Course Tracking
|
#### Course Tracking
|
||||||
|
|
||||||
- `student`, `course`, `enrollment_date`, `start_date`, `expected_end_date`
|
- `student`, `course`, `enrollment_date`, `start_date`, `expected_end_date`
|
||||||
- `actual_end_date`, `progress_status`, `completion_percentage`, `current_period`
|
- `actual_end_date`, `progress_status`, `completion_percentage`, `current_period`
|
||||||
- `period_start_date`, `period_end_date`, `notes`
|
- `period_start_date`, `period_end_date`, `notes`
|
||||||
|
|
||||||
#### Teacher-Parent Meeting
|
#### Teacher-Parent Meeting
|
||||||
|
|
||||||
- `meeting_date`, `meeting_time`, `duration`, `status`, `agenda`, `notes`
|
- `meeting_date`, `meeting_time`, `duration`, `status`, `agenda`, `notes`
|
||||||
- `cancellation_reason`, `meeting_link`, `is_online`
|
- `cancellation_reason`, `meeting_link`, `is_online`
|
||||||
|
|
||||||
### Security Models
|
### Security Models
|
||||||
|
|
||||||
- `TOTPSecret`: OTP secret keys
|
- `TOTPSecret`: OTP secret keys
|
||||||
- `ResetToken`: Password reset tokens
|
- `ResetToken`: Password reset tokens
|
||||||
|
|
||||||
## 🔌 API Endpoints
|
## 🔌 API Endpoints
|
||||||
|
|
||||||
### Authentication & Security
|
### Authentication & Security
|
||||||
|
|
||||||
- `POST /password-reset/` - Password reset options
|
- `POST /password-reset/` - Password reset options
|
||||||
- `POST /password-reset/phone/` - Phone-based password reset
|
- `POST /password-reset/phone/` - Phone-based password reset
|
||||||
- `POST /password-reset/phone/verify/` - Verify phone OTP
|
- `POST /password-reset/phone/verify/` - Verify phone OTP
|
||||||
@@ -477,6 +523,7 @@ OTP_EXPIRY=300 # OTP expiry time in seconds
|
|||||||
- `POST /check-weak-password/` - Password strength check
|
- `POST /check-weak-password/` - Password strength check
|
||||||
|
|
||||||
### Dashboard & Profile
|
### Dashboard & Profile
|
||||||
|
|
||||||
- `GET /dashboard/` - Main dashboard
|
- `GET /dashboard/` - Main dashboard
|
||||||
- `GET /student-dashboard/` - Student dashboard
|
- `GET /student-dashboard/` - Student dashboard
|
||||||
- `GET /teacher-dashboard/` - Teacher dashboard
|
- `GET /teacher-dashboard/` - Teacher dashboard
|
||||||
@@ -487,6 +534,7 @@ OTP_EXPIRY=300 # OTP expiry time in seconds
|
|||||||
- `POST /change-password/` - Change password
|
- `POST /change-password/` - Change password
|
||||||
|
|
||||||
### Leave Management
|
### Leave Management
|
||||||
|
|
||||||
- `POST /request-leave/` - Request student leave
|
- `POST /request-leave/` - Request student leave
|
||||||
- `POST /request-staff-leave/` - Request staff leave
|
- `POST /request-staff-leave/` - Request staff leave
|
||||||
- `POST /approve-student-leave/<int:leave_id>/` - Approve student leave
|
- `POST /approve-student-leave/<int:leave_id>/` - Approve student leave
|
||||||
@@ -495,6 +543,7 @@ OTP_EXPIRY=300 # OTP expiry time in seconds
|
|||||||
- `POST /reject-staff-leave/<int:leave_id>/` - Reject staff leave
|
- `POST /reject-staff-leave/<int:leave_id>/` - Reject staff leave
|
||||||
|
|
||||||
### Feedback System
|
### Feedback System
|
||||||
|
|
||||||
- `POST /submit-feedback/` - Submit general feedback
|
- `POST /submit-feedback/` - Submit general feedback
|
||||||
- `POST /submit-institute-feedback/` - Submit institute feedback
|
- `POST /submit-institute-feedback/` - Submit institute feedback
|
||||||
- `POST /submit-staff-institute-feedback/` - Submit staff institute feedback
|
- `POST /submit-staff-institute-feedback/` - Submit staff institute feedback
|
||||||
@@ -502,6 +551,7 @@ OTP_EXPIRY=300 # OTP expiry time in seconds
|
|||||||
- `POST /submit-parent-institute-feedback/` - Submit parent institute feedback
|
- `POST /submit-parent-institute-feedback/` - Submit parent institute feedback
|
||||||
|
|
||||||
### Subject & Course Management
|
### Subject & Course Management
|
||||||
|
|
||||||
- `GET /subject/<int:subject_id>/files/` - Get subject files
|
- `GET /subject/<int:subject_id>/files/` - Get subject files
|
||||||
- `GET /subject/<int:subject_id>/syllabus/` - View subject syllabus
|
- `GET /subject/<int:subject_id>/syllabus/` - View subject syllabus
|
||||||
- `GET /get-subjects/` - Get all subjects
|
- `GET /get-subjects/` - Get all subjects
|
||||||
@@ -513,15 +563,18 @@ OTP_EXPIRY=300 # OTP expiry time in seconds
|
|||||||
- `GET /get-teacher-subjects/` - Get teacher's subjects
|
- `GET /get-teacher-subjects/` - Get teacher's subjects
|
||||||
|
|
||||||
### Attendance Management
|
### Attendance Management
|
||||||
|
|
||||||
- `POST /save-attendance/` - Save attendance
|
- `POST /save-attendance/` - Save attendance
|
||||||
- `GET /get-attendance-form/` - Get attendance form
|
- `GET /get-attendance-form/` - Get attendance form
|
||||||
- `GET /get-students/` - Get student list
|
- `GET /get-students/` - Get student list
|
||||||
|
|
||||||
### Notice Management
|
### Notice Management
|
||||||
|
|
||||||
- `POST /add-notice/` - Add new notice
|
- `POST /add-notice/` - Add new notice
|
||||||
- `POST /delete-notice/<int:notice_id>/` - Delete notice
|
- `POST /delete-notice/<int:notice_id>/` - Delete notice
|
||||||
|
|
||||||
### Parent-Teacher Meeting
|
### Parent-Teacher Meeting
|
||||||
|
|
||||||
- `POST /schedule-meeting/` - Schedule a meeting
|
- `POST /schedule-meeting/` - Schedule a meeting
|
||||||
- `POST /update-meeting/<int:meeting_id>/` - Update meeting details
|
- `POST /update-meeting/<int:meeting_id>/` - Update meeting details
|
||||||
- `POST /cancel-meeting/<int:meeting_id>/` - Cancel a meeting
|
- `POST /cancel-meeting/<int:meeting_id>/` - Cancel a meeting
|
||||||
@@ -529,25 +582,28 @@ OTP_EXPIRY=300 # OTP expiry time in seconds
|
|||||||
- `GET /get-upcoming-meetings/` - Get upcoming meetings
|
- `GET /get-upcoming-meetings/` - Get upcoming meetings
|
||||||
|
|
||||||
### Course Progress
|
### Course Progress
|
||||||
|
|
||||||
- `GET /get-course-progress/<int:student_id>/` - Get student's course progress
|
- `GET /get-course-progress/<int:student_id>/` - Get student's course progress
|
||||||
- `POST /update-course-progress/` - Update course progress
|
- `POST /update-course-progress/` - Update course progress
|
||||||
- `GET /get-progress-analytics/` - Get progress analytics
|
- `GET /get-progress-analytics/` - Get progress analytics
|
||||||
|
|
||||||
### Firebase Integration
|
### Firebase Integration
|
||||||
|
|
||||||
- `POST /saveFCMToken/` - Save Firebase Cloud Messaging token
|
- `POST /saveFCMToken/` - Save Firebase Cloud Messaging token
|
||||||
|
|
||||||
### 🔐 Authentication System
|
### 🔐 Authentication System
|
||||||
|
|
||||||
#### OTP Verification
|
#### OTP Verification
|
||||||
|
|
||||||
- Phone-based OTP verification
|
- Phone-based OTP verification
|
||||||
- OTP expiry management
|
- OTP expiry management
|
||||||
- OTP resend functionality
|
- OTP resend functionality
|
||||||
- Secure OTP storage
|
- Secure OTP storage
|
||||||
|
|
||||||
|
|
||||||
## 📱 Frontend Features
|
## 📱 Frontend Features
|
||||||
|
|
||||||
### User Interface
|
### User Interface
|
||||||
|
|
||||||
- Responsive design
|
- Responsive design
|
||||||
- Dark/Light mode
|
- Dark/Light mode
|
||||||
- Custom themes
|
- Custom themes
|
||||||
@@ -555,6 +611,7 @@ OTP_EXPIRY=300 # OTP expiry time in seconds
|
|||||||
- Mobile-first approach
|
- Mobile-first approach
|
||||||
|
|
||||||
### Interactive Features
|
### Interactive Features
|
||||||
|
|
||||||
- Real-time updates
|
- Real-time updates
|
||||||
- File uploads
|
- File uploads
|
||||||
- Data visualization
|
- Data visualization
|
||||||
@@ -562,6 +619,7 @@ OTP_EXPIRY=300 # OTP expiry time in seconds
|
|||||||
- Dynamic content loading
|
- Dynamic content loading
|
||||||
|
|
||||||
### Mobile Optimization
|
### Mobile Optimization
|
||||||
|
|
||||||
- Touch-friendly interface
|
- Touch-friendly interface
|
||||||
- Offline support
|
- Offline support
|
||||||
- Push notifications
|
- Push notifications
|
||||||
@@ -571,11 +629,13 @@ OTP_EXPIRY=300 # OTP expiry time in seconds
|
|||||||
## 🔍 Testing
|
## 🔍 Testing
|
||||||
|
|
||||||
### Current Test Coverage
|
### Current Test Coverage
|
||||||
|
|
||||||
- Unit Tests: Basic test structure in place
|
- Unit Tests: Basic test structure in place
|
||||||
- API Tests: Endpoint testing framework available
|
- API Tests: Endpoint testing framework available
|
||||||
- Integration Tests: Setup for comprehensive testing
|
- Integration Tests: Setup for comprehensive testing
|
||||||
|
|
||||||
### Running Tests
|
### Running Tests
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Run all tests
|
# Run all tests
|
||||||
python manage.py test
|
python manage.py test
|
||||||
@@ -589,17 +649,21 @@ coverage report
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Test Areas
|
### Test Areas
|
||||||
|
|
||||||
1. Authentication & Authorization
|
1. Authentication & Authorization
|
||||||
|
|
||||||
- OTP verification
|
- OTP verification
|
||||||
- Password reset
|
- Password reset
|
||||||
- Role-based access
|
- Role-based access
|
||||||
|
|
||||||
2. Data Management
|
2. Data Management
|
||||||
|
|
||||||
- CRUD operations
|
- CRUD operations
|
||||||
- Data validation
|
- Data validation
|
||||||
- File handling
|
- File handling
|
||||||
|
|
||||||
3. Business Logic
|
3. Business Logic
|
||||||
|
|
||||||
- Attendance calculation
|
- Attendance calculation
|
||||||
- Leave approval workflow
|
- Leave approval workflow
|
||||||
- Course progress tracking
|
- Course progress tracking
|
||||||
@@ -612,6 +676,7 @@ coverage report
|
|||||||
## 📈 Performance
|
## 📈 Performance
|
||||||
|
|
||||||
### Optimization Techniques
|
### Optimization Techniques
|
||||||
|
|
||||||
- Database indexing
|
- Database indexing
|
||||||
- Query optimization
|
- Query optimization
|
||||||
- Caching
|
- Caching
|
||||||
@@ -621,6 +686,7 @@ coverage report
|
|||||||
- CDN integration
|
- CDN integration
|
||||||
|
|
||||||
### Monitoring
|
### Monitoring
|
||||||
|
|
||||||
- Performance metrics
|
- Performance metrics
|
||||||
- Error tracking
|
- Error tracking
|
||||||
- User analytics
|
- User analytics
|
||||||
@@ -636,6 +702,7 @@ coverage report
|
|||||||
5. Create a Pull Request
|
5. Create a Pull Request
|
||||||
|
|
||||||
### Code Style
|
### Code Style
|
||||||
|
|
||||||
- Follow PEP 8
|
- Follow PEP 8
|
||||||
- Use type hints
|
- Use type hints
|
||||||
- Write docstrings
|
- Write docstrings
|
||||||
@@ -643,6 +710,7 @@ coverage report
|
|||||||
- Follow Django best practices
|
- Follow Django best practices
|
||||||
|
|
||||||
### Commit Messages
|
### Commit Messages
|
||||||
|
|
||||||
- Use present tense
|
- Use present tense
|
||||||
- Be descriptive
|
- Be descriptive
|
||||||
- Reference issues
|
- Reference issues
|
||||||
@@ -663,6 +731,7 @@ GitHub: https://github.com/S4NKALP
|
|||||||
```
|
```
|
||||||
|
|
||||||
### 📝 Citation
|
### 📝 Citation
|
||||||
|
|
||||||
If you're using this project in an academic context, you can cite it as:
|
If you're using this project in an academic context, you can cite it as:
|
||||||
|
|
||||||
```bibtex
|
```bibtex
|
||||||
@@ -676,6 +745,7 @@ If you're using this project in an academic context, you can cite it as:
|
|||||||
```
|
```
|
||||||
|
|
||||||
### 🤝 Acknowledgments
|
### 🤝 Acknowledgments
|
||||||
|
|
||||||
- Thanks to all contributors who have helped improve this project
|
- Thanks to all contributors who have helped improve this project
|
||||||
- Special thanks to the open-source community for their valuable resources
|
- Special thanks to the open-source community for their valuable resources
|
||||||
- Appreciation to all users who have provided feedback and suggestions
|
- Appreciation to all users who have provided feedback and suggestions
|
||||||
@@ -691,43 +761,3 @@ If you're using this project in an academic context, you can cite it as:
|
|||||||
[](https://twitter.com/sankalp)
|
[](https://twitter.com/sankalp)
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## 💰 Project Costs
|
|
||||||
|
|
||||||
### Development & Implementation
|
|
||||||
- Backend Development: NPR 200,000
|
|
||||||
- Frontend Development: NPR 160,000
|
|
||||||
- QA Engineering: NPR 60,000
|
|
||||||
- Project Management: NPR 240,000
|
|
||||||
- Development Tools & Licenses: NPR 15,000
|
|
||||||
- Testing Tools: NPR 10,000
|
|
||||||
- Documentation Tools: NPR 5,000
|
|
||||||
|
|
||||||
### Annual Infrastructure & Services
|
|
||||||
- Firebase Services: NPR 10,000/year
|
|
||||||
- Google Cloud Storage: NPR 8,000/year
|
|
||||||
- Domain & SSL: NPR 3,000/year
|
|
||||||
- Server Hosting: NPR 20,000/year
|
|
||||||
|
|
||||||
### Support & Maintenance
|
|
||||||
- User Training: NPR 20,000
|
|
||||||
- Documentation: NPR 15,000
|
|
||||||
- Technical Support (First Year): NPR 30,000
|
|
||||||
|
|
||||||
### Total First Year Cost: NPR 601,000
|
|
||||||
|
|
||||||
## 🌍 Feasibility
|
|
||||||
|
|
||||||
### Target Areas
|
|
||||||
- Urban Areas with Internet Connectivity
|
|
||||||
- Educational Institutions
|
|
||||||
- Government Offices
|
|
||||||
- Private Organizations
|
|
||||||
- Healthcare Facilities
|
|
||||||
|
|
||||||
### Key Considerations
|
|
||||||
- Scalable architecture for future expansion
|
|
||||||
- Mobile-responsive design
|
|
||||||
- Real-time data processing capabilities
|
|
||||||
- Secure data handling and storage
|
|
||||||
- Offline support capabilities
|
|
||||||
Reference in new issue
Block a user