# ๐Ÿ“š Student Management System (SMS)
[![Python](https://img.shields.io/badge/python-3.x-blue.svg)](https://www.python.org/) [![Django](https://img.shields.io/badge/django-5.1.7-green.svg)](https://www.djangoproject.com/) [![License](https://img.shields.io/badge/license-MIT-yellow.svg)](LICENSE) [![Stars](https://img.shields.io/github/stars/S4NKALP/Student-Management-System-In-Django)](https://github.com/S4NKALP/Student-Management-System-In-Django/stargazers) [![Arch Linux](https://img.shields.io/badge/Arch%20Linux-1793D1?logo=arch-linux&logoColor=white)](https://archlinux.org/) [![Status](https://img.shields.io/badge/status-active-success.svg)]() A modern and comprehensive Student Management System built with Django.
## ๐Ÿ’ป Tech Stack
### ๐Ÿ”ฅ Core Technologies | Python | Django | JavaScript | MySQL | REST API | |:---:|:---:|:---:|:---:|:---:| | Python | Django | JavaScript | MySQL | REST API | ### โšก Additional Technologies | Redis | Nginx | Bootstrap | HTML5 | CSS3 | Git | |:---:|:---:|:---:|:---:|:---:|:---:| | Redis | Nginx | Bootstrap | HTML5 | CSS3 | Git |
## ๐Ÿ–ฅ๏ธ 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
| 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 |
## ๐Ÿš€ 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
### โš ๏ธ Important Notice ``` This is a Minor Project created for educational purposes. Features listed in the roadmap may or may not be implemented. ```
### ๐ŸŽฏ 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
[![GitHub Issues](https://img.shields.io/github/issues/S4NKALP/Student-Management-System-In-Django)](https://github.com/S4NKALP/Student-Management-System-In-Django/issues) [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/S4NKALP/Student-Management-System-In-Django)](https://github.com/S4NKALP/Student-Management-System-In-Django/pulls) [![Documentation](https://img.shields.io/badge/docs-wiki-blue)](https://github.com/S4NKALP/Student-Management-System-In-Django/wiki)
## ๐Ÿ™ 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
[![License](https://img.shields.io/badge/license-MIT-yellow.svg)](LICENSE)
---
### Made with โค๏ธ by [Sankalp](https://github.com/S4NKALP) [![GitHub](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white)](https://github.com/S4NKALP)