Skip to content

ketanop321/classync

Repository files navigation

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 Logo

ClassSync 📅✨

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.

🌟 Project Overview

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!

Key Features

  • 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.

🛠️ Technologies Used

  • React
  • Tailwind css
  • React-Route (For route)
  • Recharts and Chart.js for data visualization
  • Supabase (Auth, Postgres, Storage)

⚙️ Setup and Installation

Follow these steps to set up the project locally:

  1. Clone the Repository
git clone https://github.com/ketanop321/classsync.git
cd classsync
  1. Install Dependencies
npm install
  1. Configure Supabase Environment
cp .env.example .env.local

Fill in these values in .env.local:

  • REACT_APP_SUPABASE_URL
  • REACT_APP_SUPABASE_ANON_KEY
  1. Run Supabase Migration Use SQL file:
  • supabase/migrations/20260404_mvp_schema.sql

You can run it from Supabase SQL editor or with psql:

$env:PGPASSWORD='YOUR_DB_PASSWORD'; $env:PGSSLMODE='require'; psql -h db.<project-id>.supabase.co -p 5432 -U postgres -d postgres -v ON_ERROR_STOP=1 -f "supabase/migrations/20260404_mvp_schema.sql"
  1. Start the Development Server
npm start

Access the app at http://localhost:3000.


🚀 Usage

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 Vercel, Netlify, or any preferred static hosting provider.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙌 Acknowledgements

Special thanks to all contributors and testers who made ClassSync possible. Let’s make education simpler, one feature at a time!

About

Offline hackathon project coducted at BIT patna

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors