huge updates i donot track what updates i have made
This commit is contained in:
55 files changed
+11072
-1415
No files matched your search
@@ -1,27 +1,230 @@
|
||||
<p align="center">
|
||||
<img src="./assets/logo.png" alt="Logo">
|
||||
</p>
|
||||
# 📚 Student Management System (SMS)
|
||||
|
||||
<h1 align="center">Student Management System In Django</h1>
|
||||
<div align="center">
|
||||
|
||||
<p align="center">
|
||||
[](https://www.python.org/)
|
||||
[](https://www.djangoproject.com/)
|
||||
[](LICENSE)
|
||||
[](https://github.com/S4NKALP/Student-Management-System-In-Django/stargazers)
|
||||
[](https://archlinux.org/)
|
||||
[]()
|
||||
|
||||
<a href="https://github.com/S4NKALP/Student-Management-System-In-Django//graphs/contributors">
|
||||
<img alt="People" src="https://img.shields.io/github/contributors/S4NKALP/Student-Management-System-In-Django/?style=flat&color=ffaaf2&label=People"> </a>
|
||||
A modern and comprehensive Student Management System built with Django.
|
||||
|
||||
<a href="https://github.com/S4NKALP/Student-Management-System-In-Django/stargazers">
|
||||
<img alt="Stars" src="https://img.shields.io/github/stars/S4NKALP/Student-Management-System-In-Django/?style=flat&color=98c379&label=Stars"></a>
|
||||
</div>
|
||||
|
||||
<a href="https://github.com/S4NKALP/Student-Management-System-In-Django//network/members">
|
||||
<img alt="Forks" src="https://img.shields.io/github/forks/S4NKALP/Student-Management-System-In-Django/?style=flat&color=66a8e0&label=Forks"> </a>
|
||||
## 💻 Tech Stack
|
||||
|
||||
<a href="https://github.com/S4NKALP/Student-Management-System-In-Django//watchers">
|
||||
<img alt="Watches" src="https://img.shields.io/github/watchers/S4NKALP/Student-Management-System-In-Django/?style=flat&color=f5d08b&label=Watches"> </a>
|
||||
<div align="center">
|
||||
|
||||
<a href="https://github.com/S4NKALP/Student-Management-System-In-Django//pulse">
|
||||
<img alt="Last Updated" src="https://img.shields.io/github/last-commit/S4NKALP/Student-Management-System-In-Django/?style=flat&color=e06c75&label="> </a>
|
||||
</p>
|
||||
### 🔥 Core Technologies
|
||||
| <img src="https://techstack-generator.vercel.app/python-icon.svg" alt="Python" width="100" height="100"/> | <img src="https://techstack-generator.vercel.app/django-icon.svg" alt="Django" width="100" height="100"/> | <img src="https://techstack-generator.vercel.app/js-icon.svg" alt="JavaScript" width="100" height="100"/> | <img src="https://techstack-generator.vercel.app/mysql-icon.svg" alt="MySQL" width="100" height="100"/> | <img src="https://techstack-generator.vercel.app/restapi-icon.svg" alt="REST API" width="100" height="100"/> |
|
||||
|:---:|:---:|:---:|:---:|:---:|
|
||||
| <b>Python</b> | <b>Django</b> | <b>JavaScript</b> | <b>MySQL</b> | <b>REST API</b> |
|
||||
|
||||
<br>
|
||||
### ⚡ Additional Technologies
|
||||
| <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/redis/redis-original-wordmark.svg" alt="Redis" width="80" height="80"/> | <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/nginx/nginx-original.svg" alt="Nginx" width="80" height="80"/> | <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/bootstrap/bootstrap-plain-wordmark.svg" alt="Bootstrap" width="80" height="80"/> | <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/html5/html5-original-wordmark.svg" alt="HTML5" width="80" height="80"/> | <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/css3/css3-original-wordmark.svg" alt="CSS3" width="80" height="80"/> | <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/git/git-original-wordmark.svg" alt="Git" width="80" height="80"/> |
|
||||
|:---:|:---:|:---:|:---:|:---:|:---:|
|
||||
| <b>Redis</b> | <b>Nginx</b> | <b>Bootstrap</b> | <b>HTML5</b> | <b>CSS3</b> | <b>Git</b> |
|
||||
|
||||
# WIP
|
||||
</div>
|
||||
|
||||
## 🖥️ Development Environment
|
||||
|
||||
- **Processor**: Intel Core i5-7300U
|
||||
- **Operating System**: Arch Linux
|
||||
- **Window Manager**: [Hyprland](https://github.com/S4NKALP/hyprland)
|
||||
- **Status Bar**: [Modus](https://github.com/S4NKALP/Modus)
|
||||
- **Editor**: [Neovim](https://github.com/S4NKALP/nvim)
|
||||
|
||||
## ✨ Key Features
|
||||
|
||||
<div align="center">
|
||||
|
||||
| Feature | Description |
|
||||
|---------|-------------|
|
||||
| 👥 Multi-User Roles | Admin, Staff, and Student interfaces |
|
||||
| 📚 Course Management | Comprehensive course and subject tracking |
|
||||
| 📊 Attendance System | Real-time attendance monitoring |
|
||||
| 📝 Leave Management | Streamlined leave application process |
|
||||
| 📢 Notice Board | Instant announcements and updates |
|
||||
| 💬 Feedback System | Student and staff feedback collection |
|
||||
| 🔐 OTP Verification | Secure authentication system |
|
||||
| ☁️ Cloud Storage | Google Cloud integration |
|
||||
| 🔥 Firebase | Real-time notifications and auth |
|
||||
|
||||
</div>
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### Linux Users
|
||||
```bash
|
||||
# Clone & Setup
|
||||
git clone https://github.com/S4NKALP/Student-Management-System-In-Django.git
|
||||
cd Student-Management-System-In-Django
|
||||
python -m venv venv && source venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
|
||||
# Configure
|
||||
cp .env.example .env # Edit with your settings
|
||||
|
||||
# Run
|
||||
python manage.py migrate
|
||||
python manage.py createsuperuser
|
||||
python manage.py runserver
|
||||
```
|
||||
|
||||
### Windows Users
|
||||
```powershell
|
||||
# Prerequisites
|
||||
# Install Python from https://www.python.org/downloads/
|
||||
# Install Git from https://git-scm.com/download/win
|
||||
# Install Visual C++ Build Tools: https://visualstudio.microsoft.com/visual-cpp-build-tools/
|
||||
|
||||
# Clone & Setup
|
||||
git clone https://github.com/S4NKALP/Student-Management-System-In-Django.git
|
||||
cd Student-Management-System-In-Django
|
||||
python -m venv venv
|
||||
.\venv\Scripts\activate
|
||||
pip install -r requirements.txt
|
||||
|
||||
# Configure
|
||||
copy .env.example .env
|
||||
# Edit .env file with your settings
|
||||
|
||||
# Run
|
||||
python manage.py migrate
|
||||
python manage.py createsuperuser
|
||||
python manage.py runserver
|
||||
```
|
||||
|
||||
### ⚠️ Common Issues (Windows)
|
||||
- If `pip install` fails, make sure you have Visual C++ Build Tools installed
|
||||
- If `python` command not found, add Python to your PATH environment variable
|
||||
- If permission errors occur, run Command Prompt as Administrator
|
||||
- If virtualenv fails, try: `python -m pip install --upgrade virtualenv`
|
||||
|
||||
### 🔐 Environment Variables (.env)
|
||||
```env
|
||||
# Django Settings
|
||||
DEBUG=True
|
||||
SECRET_KEY=your-secret-key-here
|
||||
ALLOWED_HOSTS=localhost,127.0.0.1
|
||||
|
||||
# Database Configuration
|
||||
DB_NAME=sms_db
|
||||
DB_USER=your_db_user
|
||||
DB_PASSWORD=your_db_password
|
||||
DB_HOST=localhost
|
||||
DB_PORT=3306
|
||||
|
||||
# Email Configuration (for OTP)
|
||||
EMAIL_BACKEND=django.core.mail.backends.smtp.EmailBackend
|
||||
EMAIL_HOST=smtp.gmail.com
|
||||
EMAIL_PORT=587
|
||||
EMAIL_USE_TLS=True
|
||||
EMAIL_HOST_USER=your-email@gmail.com
|
||||
EMAIL_HOST_PASSWORD=your-app-specific-password
|
||||
|
||||
# Firebase Configuration
|
||||
FIREBASE_DATABASE_URL=your-firebase-url
|
||||
FIREBASE_TYPE=service_account
|
||||
FIREBASE_PROJECT_ID=your-project-id
|
||||
FIREBASE_PRIVATE_KEY_ID=your-private-key-id
|
||||
FIREBASE_PRIVATE_KEY=your-private-key
|
||||
FIREBASE_CLIENT_EMAIL=your-client-email
|
||||
FIREBASE_CLIENT_ID=your-client-id
|
||||
FIREBASE_AUTH_URI=https://accounts.google.com/o/oauth2/auth
|
||||
FIREBASE_TOKEN_URI=https://oauth2.googleapis.com/token
|
||||
FIREBASE_AUTH_PROVIDER_X509_CERT_URL=https://www.googleapis.com/oauth2/v1/certs
|
||||
FIREBASE_CLIENT_X509_CERT_URL=your-cert-url
|
||||
|
||||
# Google Cloud Storage
|
||||
GS_BUCKET_NAME=your-bucket-name
|
||||
GS_CREDENTIALS=path/to/credentials.json
|
||||
```
|
||||
|
||||
> **Note**: Never commit your `.env` file to version control. Keep your credentials secure!
|
||||
|
||||
## 🎯 Project Roadmap
|
||||
|
||||
<div align="center">
|
||||
|
||||
### ⚠️ Important Notice
|
||||
```
|
||||
This is a Minor Project created for educational purposes.
|
||||
Features listed in the roadmap may or may not be implemented.
|
||||
```
|
||||
|
||||
</div>
|
||||
|
||||
### 🎯 Current (v1.0)
|
||||
- ✅ Core SMS functionality
|
||||
- ✅ User management
|
||||
- ✅ Course tracking
|
||||
- ✅ Basic features
|
||||
|
||||
### 🔜 Upcoming (v1.1+)
|
||||
- 👨👩👧👦 Parents dashboard
|
||||
- 📚 Teacher study materials
|
||||
- 📖 Library management
|
||||
- 📊 Enhanced analytics
|
||||
- 🤝 Parent-teacher meetings
|
||||
|
||||
## 📮 Support & Links
|
||||
|
||||
<div align="center">
|
||||
|
||||
[](https://github.com/S4NKALP/Student-Management-System-In-Django/issues)
|
||||
[](https://github.com/S4NKALP/Student-Management-System-In-Django/pulls)
|
||||
[](https://github.com/S4NKALP/Student-Management-System-In-Django/wiki)
|
||||
|
||||
</div>
|
||||
|
||||
## 🙏 Credits
|
||||
|
||||
If you use this project in your work, please give credit where credit is due:
|
||||
|
||||
```markdown
|
||||
Student Management System
|
||||
Created by Sankalp
|
||||
GitHub: https://github.com/S4NKALP
|
||||
```
|
||||
|
||||
### 📝 Citation
|
||||
If you're using this project in an academic context, you can cite it as:
|
||||
|
||||
```bibtex
|
||||
@software{StudentManagementSystem2024,
|
||||
author = {Sankalp},
|
||||
title = {Student Management System},
|
||||
year = {2024},
|
||||
publisher = {GitHub},
|
||||
url = {https://github.com/S4NKALP/Student-Management-System-In-Django}
|
||||
}
|
||||
```
|
||||
|
||||
### 🤝 Acknowledgments
|
||||
- Thanks to all contributors who have helped improve this project
|
||||
- Special thanks to the open-source community for their valuable resources
|
||||
- Appreciation to all users who have provided feedback and suggestions
|
||||
|
||||
## 📄 License
|
||||
|
||||
<div align="center">
|
||||
|
||||
[](LICENSE)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
### Made with ❤️ by [Sankalp](https://github.com/S4NKALP)
|
||||
|
||||
[](https://github.com/S4NKALP)
|
||||
<!-- [](https://linkedin.com/in/sankalp)
|
||||
[](https://twitter.com/sankalp) -->
|
||||
|
||||
</div>
|
||||
Reference in new issue
Block a user