student-hub / acs-upb-mobile

A mobile application for students at ACS UPB.
MIT License
27 stars 22 forks source link
android dart flutter hacktoberfest ios upb

ACS UPB Mobile

License Linter Tests codecov extra_pedantic on pub.dev

Facebook Instagram

A mobile application for students at ACS UPB. For now, you can try it out by accessing https://acs-upb-mobile.web.app/ or download it from Google Play by pressing the button below. Android users can also download the apk from the latest release.

Please note that some features may not work perfectly in the web version, as the app is designed to work better natively. However, please feel free to create an issue if you encounter any problem.

If you would like to contribute and don't know where to start, or you have any questions about this project, feel free to send an e-mail at acs.upb.mobile@gmail.com.

Demo

https://user-images.githubusercontent.com/25504811/120929790-1bc24080-c6f3-11eb-9360-9994110da946.mp4

Contributors

Building from source with Android Studio

Prerequisites

Building for Android

:exclamation: On Android, ACS UPB Mobile uses a separate (development) environment in debug mode. That means a completely different Firebase project - separate data, including user info.
:bulb: In order to try the release (production) version, the recommended approach is to download an APK from the Releases page. If you really need to test the release version from AS (make sure you know what you're doing), you need to change the signingConfig signingConfigs.release line to signingConfig signingConfigs.debug in android/app/build.gradle, and then run flutter run --release. Do note that the release version cannot be ran on an emulator.

Building for iOS (MacOS only)

:bulb: Running the app in debug mode is recommended for testing. To do this, run ./run-ios-flavor.sh dev. Similarly, if you need to run the release version (not recommended), you can run ./run-ios-flavor.sh prod.

Building for Web

:bulb: Running the app in debug mode is recommended for testing. To do this, replace firebaseConfig.release with firebaseConfig.debug in the web/index.html file.

Not working?

Possible fixes could be:

Test your setup by creating and running a new Flutter project (Android Studio provides a sample). If that works but this project doesn't, feel free to open an issue and describe the problem.

License

This project is under the MIT License, which means that you can do whatever you want with it, as long as you add a copy of the original MIT license and copyright notice to your work.