📅 Schedulr

Schedulr is a smart scheduling and task management tool that helps users organize their work, prioritize tasks, and generate optimized schedules.

🚀 Built as part of GirlScript Summer of Code (GSSoC).

---

✨ Features (v1)

• 📝 Add and manage tasks with deadlines
• 🤖 Auto-generate optimized daily/weekly schedules
• 📅 Visual calendar interface
• 📄 Export schedules to PDF
• 🎨 Clean and minimal UI
• 📱 Progressive Web App (PWA) support
• 🌐 Cross-platform compatibility

---

🛠 Tech Stack

• Frontend: React 19, Tailwind CSS, React Router
• Build Tool: Vite
• Backend: Python (Flask / FastAPI) - Coming Soon
• Database: PostgreSQL / SQLite - Coming Soon
• PDF Export: ReportLab / WeasyPrint - Coming Soon
• Deployment: Vercel + Heroku

---

🚀 Quick Start

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v18 or higher) - Download here
• npm (comes with Node.js) or yarn
• Git - Download here

📥 Installation Steps

1. Clone the repository

   git clone https://github.com/Caktusuki/Schedulr.git
   cd Schedulr

2. Navigate to frontend directory

   cd frontend

3. Install dependencies

   npm install
   # or
   yarn install

4. Start the development server

   npm run dev
   # or
   yarn dev

5. Open your browser

   • Navigate to http://localhost:5173/
   • You should see the Schedulr application running! 🎉

🔧 Available Scripts

In the frontend directory, you can run:

• npm run dev - Starts the development server
• npm run build - Builds the app for production
• npm run preview - Preview the production build locally
• npm run lint - Run ESLint to check code quality

📁 Project Structure

Schedulr/
├── frontend/                 # React frontend application
│   ├── public/              # Static assets (favicon, manifest, etc.)
│   ├── src/
│   │   ├── components/      # Reusable UI components
│   │   ├── pages/          # Page components
│   │   ├── App.jsx         # Main app component
│   │   └── main.jsx        # App entry point
│   ├── package.json        # Dependencies and scripts
│   └── vite.config.js      # Vite configuration
├── .github/                # GitHub workflows and templates
├── LICENSE.md              # MIT License
└── README.md              # This file

🔍 Troubleshooting

Port already in use?

• The dev server will automatically find the next available port
• Or specify a custom port: npm run dev -- --port 3000

Dependencies not installing?

• Clear npm cache: npm cache clean --force
• Delete node_modules and package-lock.json, then run npm install

Build errors?

• Ensure you're using Node.js v18 or higher: node --version
• Check for TypeScript/ESLint errors: npm run lint

---

🤝 Contributing

We love contributions! 🎉 Here's how you can help:

🐛 Found a Bug?

1. Check if it's already reported in Issues
2. If not, create a new issue

💡 Have a Feature Idea?

1. Check existing Issues and Discussions
2. Create a new issue with the enhancement label

🔧 Ready to Code?

1. Fork the repository
2. Clone your fork

   git clone https://github.com/YOUR_USERNAME/Schedulr.git

3. Create a feature branch

   git checkout -b feature/amazing-feature

4. Make your changes
5. Test your changes

   npm run lint
   npm run build

6. Commit your changes

   git commit -m "feat: add amazing feature"

7. Push to your fork

   git push origin feature/amazing-feature

8. Open a Pull Request

📝 Commit Message Guidelines

We follow Conventional Commits:

• feat: - New features
• fix: - Bug fixes
• docs: - Documentation changes
• style: - Code style changes
• refactor: - Code refactoring
• test: - Adding tests
• chore: - Maintenance tasks

---

📜 License

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

---

💡 Project Admin

• Vikyraj Deka (@Caktusuki)

🙏 Contributors

Thanks to all contributors who have helped make Schedulr better!

---

📞 Support

• 🐛 Issues: GitHub Issues
• 💬 Discussions: GitHub Discussions
• 🌟 Star this repo if you find it helpful!

---

Happy Scheduling! 📅✨