Built this project at a hackathon with my 2 other teammates(whom you can see in contributer section) conducted at BIT(patna) ,event name:-technika
ClassSync is designed to bring ease and organization to education by simplifying schedules, tracking assignments, and managing tasks, helping students and teachers stay on top of everything in a seamless and stress-free way.
ClassSync offers tools that provide a complete overview of academic schedules, tasks, and important updates. It's like having a personal assistant dedicated to school life!
- Student Announcements: Get important school updates and information.
- Recent Activities: Track recently completed tasks and assignments.
- Upcoming Exams: Stay informed about upcoming exams and schedules.
- Important Notifications: Receive critical notifications for academic life.
- Quick Links to Resources: Access essential resources in a click.
- React
- Tailwind css
- React-Route (For route)
- Firebase (For Authentication)
Follow these steps to set up the project locally:
- Clone the Repository
git clone https://github.com/ketanop321/classsync.git
cd classsync
- Install Dependencies
npm install
- Configure Firebase
- Create a Firebase project at Firebase Console.
- Obtain your Firebase credentials and set up .env variables.
REACT_APP_FIREBASE_API_KEY=your_api_key
REACT_APP_FIREBASE_AUTH_DOMAIN=your_auth_domain
REACT_APP_FIREBASE_PROJECT_ID=your_project_id
REACT_APP_FIREBASE_STORAGE_BUCKET=your_storage_bucket
REACT_APP_FIREBASE_MESSAGING_SENDER_ID=your_messaging_sender_id
REACT_APP_FIREBASE_APP_ID=your_app_id
- Start the Development Server
npm start
Access the app at http://localhost:3000.
After setting up, use the following commands for development and deployment:
- Development: Run npm start to start the local development server.
- Build: Run npm run build to create an optimized production build.
- Deploy: Deploy with Firebase, Vercel, or any preferred hosting provider.
This project is licensed under the MIT License - see the LICENSE file for details.
Special thanks to all contributors and testers who made ClassSync possible. Let’s make education simpler, one feature at a time!