diff --git a/README.md b/README.md index 9dbb981..17f1df0 100644 --- a/README.md +++ b/README.md @@ -1,80 +1,114 @@ -# ScheduleX: Attendance & Time Table Scheduling App +# 🌟 ScheduleX: Attendance & Time Table Scheduling App -A cross platform **React Native** application designed to help you track attendance and manage shcedules with ease. +

+ +

+ +

+ + View Counter + + + Demo Link + + + Figma Link + +

+ +A cross-platform **React Native** application designed to help you track attendance and manage schedules with ease. + +--- + +## ✨ Features + +- 📊 **Track Attendance**: Easily mark & monitor attendance for different classes or events. +- 🤖 **AI Scheduling**: Instantly generate an optimized timetable based on your inputs or CSV file. +- 🔁 **Timetable Sharing**: Share your timetable with others — they can import it directly without manually entering anything. +- 📋 **Task Chat**: Add, manage, and mark tasks as complete — like a to-do list with built-in accountability. +- 📆 **Timetable Management**: Create, edit, and organize your event schedules effortlessly. +- 🔔 **Reminders & Alerts**: Set alerts to remind you of low attendance. +- ☁️ **Cloud Sync**: Sync data across multiple devices. + +--- + +## 📱 App Screenshots -- Download : [Here](https://github.com/anisharma07/React-native-attendance-app/releases/download/v1.0.4/app-release.apk) +| ![Image 1](./src/assets/screenshots/ss1.jpeg) | ![Image 2](./src/assets/screenshots/ss2.jpeg) | ![Image 3](./src/assets/screenshots/ss3.jpeg) | +| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | +| ![Image 4](./src/assets/screenshots/ss4.jpeg) | ![Image 5](./src/assets/screenshots/ss5.jpeg) | ![Image 6](./src/assets/screenshots/ss6.jpeg) | -- Figma Design : [Visit](https://www.figma.com/design/DrY27OZ8HGY1tmchlbkqes/Schedule-Keeper?node-id=12-2&p=f&t=gkQeY0d9I6aBPi8E-0) +--- -## Features +## 📜 Assignments Note -- 📊 **Track Attendance**: Easily mark & monitor attendance for different classes or events. -- 🤖 **AI Scheduling**: Instantly generate an optimized timetable based on your inputs or CSV file. -- 🔁 **Timetable Sharing**: Share your timetable with others — they can import it directly without manually entering anything. -- 📋 **Task Chat**: Add, manage, and mark tasks as complete — like a to-do list with built-in accountability. -- 📆 **Timetable Management**: Create, edit, and organize your event schedules effortlessly. -- 🔔 **Reminders & Alerts**: Set alerts to remind you of low attendance. -- ☁️ **Cloud Sync**: Sync data across multiple devices. +| Level | Time to Complete | Note | +|-------|------------------|------| +| 🟢 **Level 1** | 5 Days | Complete within 5 days or the issue may be reassigned. | +| 🟡 **Level 2** | 10 Days | Complete within 10 days or the issue may be reassigned. | +| 🔴 **Level 3** | 20 Days | Complete within 20 days or the issue may be reassigned. | -## App Screenshot +--- -| ![Image 1](./src/assets/screenshots/ss1.jpeg) | ![Image 2](./src/assets/screenshots/ss2.jpeg) | ![Image 3](./src/assets//screenshots/ss3.jpeg) | -| --------------------------------------------- | --------------------------------------------- | ---------------------------------------------- | -| ![Image 4](./src/assets/screenshots/ss4.jpeg) | ![Image 5](./src/assets/screenshots/ss5.jpeg) | ![Image 6](./src/assets/screenshots/ss6.jpeg) | +## 🛠 Tech Stack -## 🤝 Contributing +- **React Native** - Frontend framework +- **Redux** - State management +- **AsyncStorage / Firebase** - Data persistence +- **React Navigation** - Seamless app navigation -We’d love your help in improving this project! Before diving in, please take a moment to review our contribution guidelines: -📋 **[Contributing Guidelines](.github/CONTRIBUTING.md)** +--- -## 📜 Code of Conduct +## 🤝 Contributing -To ensure a welcoming and respectful community, please make sure to read and follow our Code of Conduct: +We’d love your help in improving this project! +📋 **[Contributing Guidelines](.github/CONTRIBUTING.md)** -🤝 **[Code of Conduct](.github/CODE_OF_CONDUCT.md)** +--- -## 🚀 Quick Start +## 📜 Code of Conduct -All set with the guidelines? Jump right into development by following our step-by-step setup instructions: +🤝 **[Code of Conduct](.github/CODE_OF_CONDUCT.md)** -📖 **[Setup & Installation Guide](.github/SETUP.md)** +--- -## Tech Stack +## 🚀 Quick Start -- **React Native** - Frontend framework -- **Redux** - State management -- **AsyncStorage / Firebase** - Data persistence -- **React Navigation** - Seamless app navigation -- For more, refer to labels in repo's description. +📖 **[Setup & Installation Guide](.github/SETUP.md)** -## Project Admin (GSSoC'25) +--- -- Anirudh Sharma - - GitHub - https://github.com/anisharma07 - - Mention - @anisharma07 +## 👑 Project Admin (GSSoC'25) -## Mentors (GSSoC'25) +- **Anirudh Sharma** — [GitHub](https://github.com/anisharma07) — @anisharma07 -- Irtesaam - - GitHub - https://github.com/Irtesaam - - Mention - @Irtesaam +--- -- Nikhil Balamurugan - - GitHub - https://github.com/Nikhil210206 - - Mention - @Nikhil210206 +## 🎓 Mentors (GSSoC'25) -## License +- **Irtesaam** — [GitHub](https://github.com/Irtesaam) — @Irtesaam +- **Nikhil Balamurugan** — [GitHub](https://github.com/Nikhil210206) — @Nikhil210206 -This project is licensed under the **MIT License**. See the [LICENSE.md](LICENSE.md) file for details. +--- + +## 🏆 Contributors + +Thanks to these amazing people for their contributions ❤️ + + + + --- -### 📩 Need Help? +## 📩 Need Help? + +- Tag PA or mentors in Issues/PRs for a faster response +- Join our Discord: [https://discord.gg/s8MbexBPjq](https://discord.gg/s8MbexBPjq) -- While making Issues or PR's, Please Tag any of the PA or mentors to get a faster response -- For issues or suggestions, create a GitHub issue or join our Discord community: [https://discord.gg/s8MbexBPjq](https://discord.gg/s8MbexBPjq) +---

- ✨ Vibe • Coding • Imaginations ✨ + ✨ Vibe • Coding • Imaginations