Your All-in-One Academic Hub for Saveetha School of Engineering College
Saveetha Companion is a comprehensive web application designed specifically for students at Saveetha Engineering College. It serves as a centralized platform that simplifies academic life by providing essential tools like CGPA and attendance calculators, AI-powered learning resources, concept map discovery, placement preparation tools, and much more.
The platform features a clean, modern interface with both light and dark theme support, making it accessible and user-friendly for all students. With Firebase authentication and real-time data synchronization, students can access their personalized dashboard from any device.
- Simplify Academic Calculations - Instant CGPA and attendance percentage calculations
- AI-Powered Learning - Intelligent concept map finder and personalized course roadmaps
- Centralized Resources - One place for hackathons, internships, jobs, and projects
- Real-time Updates - Instant notifications for important academic announcements
- Admin Management - Comprehensive admin dashboard for content management
- CGPA Calculator - Calculate your cumulative grade point average with dynamic updates
- Subject-wise Attendance Calculator - Track attendance percentage for each subject individually
- Concept Map Finder - AI-powered search to discover relevant concept maps based on topics
- AI Tutor - Interactive AI assistant for learning support
- Course Roadmap Generator - Personalized academic journey planning with AI
- Course Dashboard - Track your enrolled courses and progress
- MCQ Quizzes - Practice with multiple-choice questions
- Coding Practice - Solve coding problems with an integrated Monaco code editor
- PDF Viewer - View academic documents directly in the browser
- Citation Generator - Generate academic citations easily
- QR Code Generator - Create QR codes for quick sharing
- Typing Test - Improve your typing speed and accuracy
- Reverse Dictionary - Find words based on definitions
- Steganography Tool - Hide messages in images
- Code Sandbox - Execute code directly in the browser
- Link Drop - Quick link sharing and management
- Hackathons - Discover upcoming hackathon opportunities
- Internships - Browse internship listings
- Jobs - Find job opportunities
- Placement Prep - Prepare for campus placements
- Faculty Directory - Find and contact faculty members
- Projects Showcase - View and share student projects
- Certifications - Track and manage your certifications
- Calendar - Stay updated with academic events
- Push Notifications - Receive real-time alerts
- Updates Feed - Stay informed about latest announcements
- User Management - Manage student accounts
- Content Management - Manage courses, MCQs, concept maps, and more
- Analytics - View platform usage statistics
- Notifications - Send announcements to students
Add your screenshots here to showcase the application's interface
Click to view screenshots
Screenshot of the main landing page with calculators
Personalized student dashboard
Real-time CGPA calculation interface
Course roadmap and learning resources
Administrative control panel
| Technology | Purpose |
|---|---|
| Next.js 15 | React framework with App Router & Turbopack |
| React 18 | UI component library |
| TypeScript 5 | Type-safe JavaScript |
| Tailwind CSS 3 | Utility-first CSS framework |
| Framer Motion | Animation library |
| Radix UI | Accessible UI primitives |
| shadcn/ui | Reusable component library |
| Lucide React | Icon library |
| Recharts | Data visualization |
| Monaco Editor | Code editor component |
| Technology | Purpose |
|---|---|
| Firebase | Authentication & Firestore database |
| Firebase Admin | Server-side Firebase operations |
| Supabase | Additional database features |
| Resend | Email service |
| Technology | Purpose |
|---|---|
| Genkit | Google AI framework |
| Google AI (Gemini) | AI-powered features |
| Technology | Purpose |
|---|---|
| ESLint | Code linting |
| PostCSS | CSS processing |
| TypeScript | Static type checking |
Before you begin, ensure you have the following installed:
- Node.js (v18.0.0 or higher) - Download
- npm (v9.0.0 or higher) or yarn
- Git - Download
- Firebase Account - Sign up
- Google AI API Key - For Genkit AI features
git clone https://github.com/ComradeMohan/saveetha-companion.git
cd saveetha-companionnpm install
# or
yarn installCreate a .env.local file in the root directory with the following variables:
# Firebase Configuration
NEXT_PUBLIC_FIREBASE_API_KEY=your_firebase_api_key
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your_project.firebaseapp.com
NEXT_PUBLIC_FIREBASE_PROJECT_ID=your_project_id
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your_project.appspot.com
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your_sender_id
NEXT_PUBLIC_FIREBASE_APP_ID=your_app_id
NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID=your_measurement_id
# Firebase Admin (Server-side)
FIREBASE_PROJECT_ID=your_project_id
FIREBASE_CLIENT_EMAIL=your_service_account_email
FIREBASE_PRIVATE_KEY="your_private_key"
# Supabase Configuration
NEXT_PUBLIC_SUPABASE_URL=your_supabase_url
NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key
# Google AI (Genkit)
GOOGLE_GENAI_API_KEY=your_google_ai_api_key
# Resend (Email Service)
RESEND_API_KEY=your_resend_api_key# Start the Next.js development server
npm run dev
# In a separate terminal, start the Genkit AI development server (optional)
npm run genkit:devOpen http://localhost:9002 in your browser to see the application.
npm run build
npm run start| Script | Description |
|---|---|
npm run dev |
Start development server with Turbopack on port 9002 |
npm run build |
Build the application for production |
npm run start |
Start the production server |
npm run lint |
Run ESLint for code quality |
npm run typecheck |
Run TypeScript type checking |
npm run genkit:dev |
Start Genkit AI development server |
npm run genkit:watch |
Start Genkit with file watching |
- CGPA Calculator
- Attendance Calculator
- AI Concept Map Finder
- User Authentication
- Admin Dashboard
- Push Notifications
- Coding Practice Platform
- Career Resources (Jobs, Internships, Hackathons)
- Tools Suite (Citation Generator, QR Generator, etc.)
- Mobile App (Android/iOS)
- Enhanced AI Tutor capabilities
- Peer-to-peer study groups
- Advanced analytics dashboard
- Offline mode support
- Multi-language support
- Video learning integration
- Student collaboration tools
- Gamification & achievements
- Integration with college ERP systems
- AI-powered study recommendations
- Virtual study rooms
- Progress sharing on social media
- Alumni network integration
Thanks to these wonderful people who have contributed to this project:
| Contributor | Role |
|---|---|
| @ComradeMohan | Project Lead & Primary Developer |
We welcome contributions from the community! Here's how you can help:
-
Fork the Repository
Click the "Fork" button at the top right of this repository, then clone your fork:
git clone https://github.com/YOUR_USERNAME/saveetha-companion.git
-
Create a Feature Branch
git checkout -b feature/AmazingFeature
-
Commit Your Changes
git commit -m 'Add some AmazingFeature' -
Push to the Branch
git push origin feature/AmazingFeature
-
Open a Pull Request
Please read our contribution guidelines before submitting a PR.
This project is open source and available for educational purposes.
- Next.js for the amazing React framework
- shadcn/ui for beautiful UI components
- Firebase for backend services
- Google AI for Genkit AI capabilities
- Vercel for hosting and deployment
- All the students of Saveetha Engineering College who provided feedback
