MiniCampus - A virtual campus app, with 💙 for students 👨🎓👩🎓
MiniCampus, MC - thrives to be the go to student app for both freshers and existing students on campus. It comes equipped with the tools and services to make life easy for a student.
- It comprises of modules as mono-repos, that each act as a standalone application serving a single purpose
Adding a new package or mono repo is powered by VGV mason_cli
On the root folder, run
$ mason make very_good_dart_package --project_name "<package_name>" --description "<package description>." -o packages On the root folder, run
$ cd packages
$ mason make very_good_flutter_packageCheckout the development progress under releases for demo builds
coming soon
This project is built using Flutter, for a getting started, checkout flutter.dev
After successful setup of your local flutter environment, fork this repository and run the following commands in the root folder
This project is powered by melos
All scripts and commands are available via melos. For IDE Support install the melos extension
Use the melos scripts to run commands
For local development, it is recommended to use dev flavor mode and firebase local emulator
Requires flutterfire_cli to be installed
To setup firebase services with flavors using FlutterFire CLI more use the melos script > setup-firebase-emulator to setup firebase cli for development mode
Please note the app id is per the one setup in pubspec following flutter_flavor convention
Flavors have been configured for vscode but for Android Studio check here
Currently MC is tested against Android devices only. It might work on iOS but this has not been tested yet, help us archive this goal 🙏
# run dev mode with flavor
$ flutter run --flavor dev -t lib/main_dev.dartFor interactive long conversations around issues, new developments, announcements and progress etc, make use of our discussions 💡 here
MC is broken down into modules (packages), each, which serve a single purpose, they act as single mini apps within the MC framework.
It comes with the following core modules and counting 😎
- Campus Market
- Learning
- Lost & Found
- Feedback
- Notifications
MC comes with default fcm push notifications, each student on successful register automatically subscribe to the following topics:
- all - for all push notifications
- gender - based on student gender males | females
- department - based on student department, using dept-code
- faculty - based per faculty
- year - based on enrollment year e.g part 1, part 4
These aim to tackle communication issues on campus to enhance announcement delivery e.g
When we want to notify all students about the opening of Payment Plans on Campus Admin
Important message from the clinic about counselling services
Broadcast announcement to all girl child about Women in Engineering event
MC strives to take advantage the available open source & free* tools
This is because MC is made by students for students
- Flutter Dart
- Firebase services
- Deta services here - for persistence free storage and nosql db
- Python, Fast Api server - for interfacing with deta
We love contributions, no contribution is small or big, every bit of it is welcome here be it technical or non-technical including suggestions, documentations and typos etc
To learn more about the different ways you can contribute to MC, see the CONTRIBUTING guide
- DonnC Lab - Initial work - DonnC
- Traders Incubator - Initial work - Dont Delete
See also the list of awesome contributors who participated in this project.
This project is licensed under the Apache License - see the LICENSE file for details
- StackOverflow - what can we do without it
- Dont Delete - for providing early feedback on technical tests and module ideation
- FlutterDevZW community
- a lot more
Place the attribution on the app's credits page and on the description page on the app store.
- learning - People illustrations by Storyset
- students - Education illustrations by Storyset
- market - Online illustrations by Storyset
- survey - Marketing illustrations by Storyset
coming soon