Skip to content

Commit 67a7ce1

Browse files
IrtesaamIrtesaam
authored
Merge pull request #128 from FireFistisDead/main
Made the changes in Readme
2 parents 4ed8b37 + 22d7162 commit 67a7ce1

1 file changed

Lines changed: 82 additions & 48 deletions

File tree

‎README.md‎

Lines changed: 82 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,114 @@
1-
# ScheduleX: Attendance & Time Table Scheduling App
1+
# 🌟 ScheduleX: Attendance & Time Table Scheduling App
22

3-
A cross platform **React Native** application designed to help you track attendance and manage shcedules with ease.
3+
<p align="center">
4+
<img src="https://media.giphy.com/media/xT9IgzoKnwFNmISR8I/giphy.gif" width="120px">
5+
</p>
6+
7+
<p align="center">
8+
<a href="https://github.com/anisharma07/React-native-attendance-app">
9+
<img src="https://komarev.com/ghpvc/?username=anisharma07&label=Views&color=brightgreen&style=flat" alt="View Counter" />
10+
</a>
11+
<a href="https://github.com/anisharma07/React-native-attendance-app/releases/download/v1.0.4/app-release.apk">
12+
<img src="https://img.shields.io/badge/Demo-APK-blue?style=flat&logo=android" alt="Demo Link" />
13+
</a>
14+
<a href="https://www.figma.com/design/DrY27OZ8HGY1tmchlbkqes/Schedule-Keeper?node-id=12-2&p=f&t=gkQeY0d9I6aBPi8E-0">
15+
<img src="https://img.shields.io/badge/Figma-Design-orange?style=flat&logo=figma" alt="Figma Link" />
16+
</a>
17+
</p>
18+
19+
A cross-platform **React Native** application designed to help you track attendance and manage schedules with ease.
20+
21+
---
22+
23+
## ✨ Features
24+
25+
- 📊 **Track Attendance**: Easily mark & monitor attendance for different classes or events.
26+
- 🤖 **AI Scheduling**: Instantly generate an optimized timetable based on your inputs or CSV file.
27+
- 🔁 **Timetable Sharing**: Share your timetable with others — they can import it directly without manually entering anything.
28+
- 📋 **Task Chat**: Add, manage, and mark tasks as complete — like a to-do list with built-in accountability.
29+
- 📆 **Timetable Management**: Create, edit, and organize your event schedules effortlessly.
30+
- 🔔 **Reminders & Alerts**: Set alerts to remind you of low attendance.
31+
- ☁️ **Cloud Sync**: Sync data across multiple devices.
32+
33+
---
34+
35+
## 📱 App Screenshots
436

5-
- Download : [Here](https://github.com/anisharma07/React-native-attendance-app/releases/download/v1.0.4/app-release.apk)
37+
| ![Image 1](./src/assets/screenshots/ss1.jpeg) | ![Image 2](./src/assets/screenshots/ss2.jpeg) | ![Image 3](./src/assets/screenshots/ss3.jpeg) |
38+
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
39+
| ![Image 4](./src/assets/screenshots/ss4.jpeg) | ![Image 5](./src/assets/screenshots/ss5.jpeg) | ![Image 6](./src/assets/screenshots/ss6.jpeg) |
640

7-
- Figma Design : [Visit](https://www.figma.com/design/DrY27OZ8HGY1tmchlbkqes/Schedule-Keeper?node-id=12-2&p=f&t=gkQeY0d9I6aBPi8E-0)
41+
---
842

9-
## Features
43+
## 📜 Assignments Note
1044

11-
- 📊 **Track Attendance**: Easily mark & monitor attendance for different classes or events.
12-
- 🤖 **AI Scheduling**: Instantly generate an optimized timetable based on your inputs or CSV file.
13-
- 🔁 **Timetable Sharing**: Share your timetable with others — they can import it directly without manually entering anything.
14-
- 📋 **Task Chat**: Add, manage, and mark tasks as complete — like a to-do list with built-in accountability.
15-
- 📆 **Timetable Management**: Create, edit, and organize your event schedules effortlessly.
16-
- 🔔 **Reminders & Alerts**: Set alerts to remind you of low attendance.
17-
- ☁️ **Cloud Sync**: Sync data across multiple devices.
45+
| Level | Time to Complete | Note |
46+
|-------|------------------|------|
47+
| 🟢 **Level 1** | 5 Days | Complete within 5 days or the issue may be reassigned. |
48+
| 🟡 **Level 2** | 10 Days | Complete within 10 days or the issue may be reassigned. |
49+
| 🔴 **Level 3** | 20 Days | Complete within 20 days or the issue may be reassigned. |
1850

19-
## App Screenshot
51+
---
2052

21-
| ![Image 1](./src/assets/screenshots/ss1.jpeg) | ![Image 2](./src/assets/screenshots/ss2.jpeg) | ![Image 3](./src/assets//screenshots/ss3.jpeg) |
22-
| --------------------------------------------- | --------------------------------------------- | ---------------------------------------------- |
23-
| ![Image 4](./src/assets/screenshots/ss4.jpeg) | ![Image 5](./src/assets/screenshots/ss5.jpeg) | ![Image 6](./src/assets/screenshots/ss6.jpeg) |
53+
## 🛠 Tech Stack
2454

25-
## 🤝 Contributing
55+
- **React Native** - Frontend framework
56+
- **Redux** - State management
57+
- **AsyncStorage / Firebase** - Data persistence
58+
- **React Navigation** - Seamless app navigation
2659

27-
We’d love your help in improving this project! Before diving in, please take a moment to review our contribution guidelines:
2860

29-
📋 **[Contributing Guidelines](.github/CONTRIBUTING.md)**
61+
---
3062

31-
## 📜 Code of Conduct
63+
## 🤝 Contributing
3264

33-
To ensure a welcoming and respectful community, please make sure to read and follow our Code of Conduct:
65+
We’d love your help in improving this project!
66+
📋 **[Contributing Guidelines](.github/CONTRIBUTING.md)**
3467

35-
🤝 **[Code of Conduct](.github/CODE_OF_CONDUCT.md)**
68+
---
3669

37-
## 🚀 Quick Start
70+
## 📜 Code of Conduct
3871

39-
All set with the guidelines? Jump right into development by following our step-by-step setup instructions:
72+
🤝 **[Code of Conduct](.github/CODE_OF_CONDUCT.md)**
4073

41-
📖 **[Setup & Installation Guide](.github/SETUP.md)**
74+
---
4275

43-
## Tech Stack
76+
## 🚀 Quick Start
4477

45-
- **React Native** - Frontend framework
46-
- **Redux** - State management
47-
- **AsyncStorage / Firebase** - Data persistence
48-
- **React Navigation** - Seamless app navigation
49-
- For more, refer to labels in repo's description.
78+
📖 **[Setup & Installation Guide](.github/SETUP.md)**
5079

51-
## Project Admin (GSSoC'25)
80+
---
5281

53-
- Anirudh Sharma
54-
- GitHub - https://github.com/anisharma07
55-
- Mention - @anisharma07
82+
## 👑 Project Admin (GSSoC'25)
5683

57-
## Mentors (GSSoC'25)
84+
- **Anirudh Sharma** — [GitHub](https://github.com/anisharma07) — @anisharma07
5885

59-
- Irtesaam
60-
- GitHub - https://github.com/Irtesaam
61-
- Mention - @Irtesaam
86+
---
6287

63-
- Nikhil Balamurugan
64-
- GitHub - https://github.com/Nikhil210206
65-
- Mention - @Nikhil210206
88+
## 🎓 Mentors (GSSoC'25)
6689

67-
## License
90+
- **Irtesaam** — [GitHub](https://github.com/Irtesaam) — @Irtesaam
91+
- **Nikhil Balamurugan** — [GitHub](https://github.com/Nikhil210206) — @Nikhil210206
6892

69-
This project is licensed under the **MIT License**. See the [LICENSE.md](LICENSE.md) file for details.
93+
---
94+
95+
## 🏆 Contributors
96+
97+
Thanks to these amazing people for their contributions ❤️
98+
99+
<a href="https://github.com/Loop-Hive/ScheduleX/graphs/contributors">
100+
<img src="https://contrib.rocks/image?repo=Loop-Hive/ScheduleX" />
101+
</a>
70102

71103
---
72104

73-
### 📩 Need Help?
105+
## 📩 Need Help?
106+
107+
- Tag PA or mentors in Issues/PRs for a faster response
108+
- Join our Discord: [https://discord.gg/s8MbexBPjq](https://discord.gg/s8MbexBPjq)
74109

75-
- While making Issues or PR's, Please Tag any of the PA or mentors to get a faster response
76-
- For issues or suggestions, create a GitHub issue or join our Discord community: [https://discord.gg/s8MbexBPjq](https://discord.gg/s8MbexBPjq)
110+
---
77111

78112
<p align="center">
79-
✨ <strong>Vibe • Coding • Imaginations</strong> ✨
113+
✨ <strong>Vibe • Coding • Imaginations</strong> ✨
80114
</p>

0 commit comments

Comments
 (0)