The Study Planner App is a comprehensive tool designed to help students and professionals manage their courses, assignments, and notes effectively. The app allows users to view courses, track assignments, and access notes with notifications for overdue tasks.
- View and manage courses.
- Track assignments with due dates.
- Access and organize course notes.
- Receive notifications for overdue assignments.
- Real-time updates for assignments and notifications.
- Flutter
- Firebase Firestore
- Firebase Authentication
- Firebase Cloud Storage
- Firebase Cloud Functions
- GoRouter for navigation
- Flutter installed on your machine.
- A Firebase project set up with Firestore, Authentication, and Cloud Storage.
-
Clone the repository:
https://github.com/HGSChandeepa/Study-Planner
-
Navigate to the project directory:
cd Study-Planner -
Install dependencies:
flutter pub get
-
Set up Firebase:
- Follow the instructions on the Firebase website to add your
google-services.json(for Android) and/orGoogleService-Info.plist(for iOS) to the appropriate directories. - Update your
firebase_options.dartwith the configuration from your Firebase project.
- Follow the instructions on the Firebase website to add your
-
Run the app:
flutter run
- Courses Screen: View and manage all courses. Tap on a course to see its assignments and notes.
- Assignments Screen: View all assignments, with the ability to see due dates and track overdue assignments.
- Notes Screen: View all notes associated with each course.
If you would like to contribute to the project:
-
Fork the repository.
-
Create a new branch:
git checkout -b feature/your-feature
-
Commit your changes:
git add . git commit -m 'Add new feature'
-
Push to the branch:
git push origin feature/your-feature
-
Create a pull request on GitHub.
This project is licensed under the MIT License - see the LICENSE file for details.