University Companion App is a versatile and user-friendly mobile application designed to assist universities and educational institutions in creating their personalized apps for students. The app provides a seamless experience for students to access and keep track of their class schedules, exam dates, and other crucial academic events. This open-source project aims to empower educational institutions to enhance students' academic experience and streamline the process of managing classes and exams.
The app is built using the following technologies:
- Flutter (https://flutter.dev/)
- Dart (https://dart.dev/)
- Provider (https://pub.dev/packages/provider)
- HTTP Package (https://pub.dev/packages/http)
- HTTP Interceptor (https://pub.dev/packages/http_interceptor)
- Logger (https://pub.dev/packages/logger)
- GoRouter (https://pub.dev/packages/go_router)
- Flex Color Scheme (https://pub.dev/packages/flex_color_scheme)
- Image Picker (https://pub.dev/packages/image_picker)
- Shared Preferences (https://pub.dev/packages/shared_preferences)
To run the project, you need to have Flutter installed on your machine. Follow the official Flutter website's instructions to set up Flutter: Flutter.dev
After installing Flutter, clone this repository to your local machine and run the command flutter pub get to install the project's dependencies.
To run the project, you can use the command flutter run or execute the project directly from your IDE.
To execute the tests, use the command flutter test.
Contributions are always welcome! If you'd like to contribute, follow the instructions below:
- Fork the project
- Create a new branch with your changes (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push the branch you created (
git push origin feature/AmazingFeature) - Open a Pull Request
This project is licensed under the MIT License. See the LICENSE file for more details.