Here's the updated README:

---

🏆 Achievement Management System

A centralized platform for tracking and showcasing academic achievements. Students access their accomplishments instantly. Teachers record them effortlessly. Everyone gets clarity.

---

🎯 The Problem

Academic achievements are scattered chaos:

• 📧 Certificates buried in email threads
• 📁 Paper documents lost in folders
• 📊 Teachers drowning in spreadsheets
• 🎓 Students can't showcase accomplishments during placements

Result: Wasted time, missed opportunities, zero visibility into actual progress.

---

✨ The Solution

Achievement Management System brings everything into one organized dashboard:

• 📍 Centralized tracking — All achievements in one place
• 📈 Visual analytics — Progress trends and insights at a glance
• ⚡ Fast entry — Teachers add records in seconds with auto-complete
• 🔍 Smart filtering — Find exactly what you need instantly
• 📄 Certificate storage — Digital proofs accessible anytime

---

🚀 Quick Start

Windows (PowerShell)

# Clone and navigate
git clone https://github.com/Eswaramuthu/Achievement-Management-System.git
cd Achievement-Management-System

# Set up environment
python -m venv venv
venv\Scripts\activate
pip install -r requirements.txt

# Configure environment variables
copy .env.example .env
# Open .env and set your SECRET_KEY and FLASK_ENV

# Initialize and run
python init_db.py
python app.py

macOS / Linux

# Clone and navigate
git clone https://github.com/Eswaramuthu/Achievement-Management-System.git
cd Achievement-Management-System

# Set up environment
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

# Configure environment variables
cp .env.example .env
# Open .env and set your SECRET_KEY and FLASK_ENV

# Initialize and run
python init_db.py
python app.py

Environment Variables

Create a .env file in the project root (use .env.example as a template) and set the following:

FLASK_ENV=development
SECRET_KEY=your-strong-secret-key-here

🌐 Open your browser → http://localhost:5000

---

🛠️ Tech Stack

Technology	Purpose
Flask	Lightweight Python web framework
Flask Sessions	Secure, server-side session management and authentication
Werkzeug	Password hashing via generate_password_hash and check_password_hash
SQLite	Embedded database for local storage
JavaScript	Dynamic interactivity (vanilla JS)
HTML/CSS	Responsive UI with theme support
Jinja2	Server-side templating

---

💡 Core Features

👨‍🎓 For Students

Feature	Description
Dashboard	View all achievements with stats at a glance
Analytics	Track your progress over time with visual charts
Filters	Search by type, year, position, or keyword
Certificates	Download proof of achievements instantly
📤 Export Cards	Generate professional PNG/PDF cards with QR codes for LinkedIn
🔗 Share & Verify	Share achievements with QR code verification links
Profile	Manage personal details and preferences

👨‍🏫 For Teachers

Feature	Description
Quick Entry	Add achievements with intuitive forms
Auto-Complete	Find students instantly as you type
Upload	Attach certificates (PDF, JPG, PNG up to 5MB)
Batch Mode	Manage multiple entries efficiently
Dashboard	View submission statistics and trends

🔐 Security & Access Control

Feature	Description
Flask Sessions	All authentication is handled server-side using secure Flask sessions — no third-party auth providers required
Password Hashing	User passwords are securely hashed in the local database using Werkzeug

🎪 Achievement Types

The system supports comprehensive tracking for:

• 💻 Hackathons — Team projects, difficulty levels, project titles
• 🏅 Coding Competitions — Platforms, languages, problem difficulty
• 📝 Paper Presentations — Journal names, conference levels, paper titles
• 🎤 Conferences — Roles, presentation types, conference tiers
• 🎭 Symposiums — Themes, event scope, participation types
• ✨ Custom Events — Flexible fields for unique achievements

---

📂 Project Structure

achievement-management-system/
│
├── app.py                    # Flask application + routing logic
├── init_db.py                # Database schema initialization
├── requirements.txt          # Python dependencies
├── .env.example              # Environment variable template
│
├── static/
│   ├── css/                  # Stylesheets + dark/light themes
│   ├── js/                   # Client-side JavaScript
│   └── certificates/         # Uploaded certificate files
│
├── templates/                # Jinja2 HTML templates
├── ams.db                    # SQLite database
├── instance/                 # Instance-specific files
│
├── README.md                 # This file
└── Contributing.md           # Contribution guidelines

---

🗄️ Database Schema

┌─────────────┐            ┌─────────────┐            ┌─────────────┐
│   Student   │            │ Achievement │            │   Teacher   │
├─────────────┤            ├─────────────┤            ├─────────────┤
│ student_id  │ PK         │ id          │ PK         │ teacher_id  │ PK
│ name        │            │ student_id  │ FK         │ name        │
│ email       │    1:N     │ teacher_id  │ FK   N:1   │ email       │
│ password    │ ─────────> │ type        │ <───────── │ password    │
│ department  │            │ event_name  │            │ department  │
│ is_approved │            │ date        │            │ is_approved │
│ ...         │            │ position    │            │ ...         │
└─────────────┘            │ certificate │            └─────────────┘
                           │ ...         │
                           └─────────────┘

---

🎨 Key Features Explained

🌓 Dark/Light Mode

Toggle between themes with one click. Preferences persist across sessions. Smooth transitions and eye-friendly color schemes.

🔎 Smart Student Search

Type student ID or name — results appear instantly. No more scrolling through endless lists. Auto-complete makes teacher workflows lightning-fast.

📊 Achievement Analytics

Visual dashboards show:

• Achievements by type (pie charts)
• Progress over time (line graphs)
• Position distribution (bar charts)
• Year-wise breakdown

📁 Certificate Management

• Upload formats: PDF, JPG, PNG
• Max file size: 5MB
• Secure storage with unique filenames
• One-click download access

🛡️ Role-Based Access Control

Routes are protected using custom Python decorators:

• @student_required — restricts access to authenticated students only
• @teacher_required — restricts access to authenticated teachers only
• @admin_required — restricts access to administrators only

Attempting to access a restricted route without the correct role redirects the user immediately, ensuring strict privilege separation across the application.

🔧 Custom Fields by Type

Each achievement category has specialized fields:

Hackathons: Team size, project title, tech stack, difficulty
Competitions: Platform, language, problem set, ranking
Papers: Journal, conference tier, impact factor, citations
Conferences: Role, presentation format, audience size
Symposiums: Theme, scope, participation mode

📤 Achievement Card Export & Sharing

Students can now generate professional achievement cards with QR codes:

• PNG Export: High-quality 300 DPI PNG images perfect for social media
• PDF Export: Printable PDF certificates ready for portfolios
• QR Codes: Scannable verification codes linking to public achievement pages
• Social Sharing: One-click sharing to LinkedIn, Twitter, and other platforms
• Public Verification: Shareable links allow anyone to verify achievements
• Dark/Light Support: Exported cards respect user's theme preference

How to Use:

1. Go to "My Achievements"
2. Click "Share Achievement" on any achievement card
3. Select "Export Card" to generate PNG/PDF
4. Download and share on LinkedIn or social media
5. Others can scan QR code to verify achievement

For detailed documentation, see ACHIEVEMENT_EXPORT_GUIDE.md.

---

🌐 Navigation Map

Page	Route	Access
Home	/	Public
Student Login	/student-login	Public
Teacher Login	/teacher-login	Public
Student Dashboard	/student-dashboard	Students only
Teacher Dashboard	/teacher-dashboard	Teachers only
View Achievements	/view-achievements	Students only
Add Achievement	/add-achievement	Teachers only
Admin Panel	/admin	Admins only

---

🤝 Contributing

We welcome contributions! Here's how to get started:

1. Fork the repository
2. Clone your fork locally
3. Create a feature branch (git checkout -b feature/amazing-feature)
4. Commit your changes (git commit -m 'Add amazing feature')
5. Push to your branch (git push origin feature/amazing-feature)
6. Open a Pull Request

📖 Read Contributing.md for detailed guidelines.

---

🗺️ Roadmap

Phase 1 (Current)

• Core achievement tracking
• Student & teacher dashboards
• Certificate upload/download
• Dark mode support
• Flask Sessions authentication
• Role-based access control (RBAC)
• Admin approval workflow

Phase 2 (In Progress)

• 🔗 LinkedIn integration & social sharing
• 📤 Achievement card export (PNG/PDF)
• QR code verification system
• 📱 Mobile app (iOS + Android)
• 🤖 AI-powered certificate validation
• 📧 Email notifications for new achievements
• 🌍 Multi-language support

Phase 3 (Future)

• 📊 Advanced predictive analytics
• 📄 Export as PDF portfolio
• ☁️ Cloud deployment options

---

📜 License

Academic project developed at SRM Institute of Science and Technology.
For educational and institutional use.

---

📬 Contact & Support

Found a bug? Have an idea? Need help?

• 🐛 Report Issues
• 💬 Discussions
• 📧 Open an issue for direct contact

---

⭐ Star this repo if you find it helpful!

Made with ❤️ at SRM Institute of Science and Technology