Skip to content

Latest commit

 

History

History
92 lines (72 loc) · 3.1 KB

README.md

File metadata and controls

92 lines (72 loc) · 3.1 KB

StudiPassau

StudiPassau Reimagined using Flutter

Lint status Translation status

The successor of the app StudiPassau , completely rewritten in Dart using Flutter framework.

The app is made for use with Android (and later Fuchsia as well), even though it should be compatible with iOS as well (in theory).

Compiling from source

The compilation from source should be straight forward (only Android):

  1. Fully install the Flutter SDK
  2. Clone this repo using git clone https://github.com/ThexXTURBOXx/studipassau.git
  3. Create a file called .env in the project's root and add the following lines, replacing your OAuth credentials:
    CLIENT_ID=<YourClientIDHere>
    CLIENT_SECRET=<OPTIONAL>
    SENTRY_DSN=<OPTIONAL>
  4. Activate my custom version of intl_utils which fixes language overrides:
    flutter pub global activate --source git https://github.com/ThexXTURBOXx/intl_utils.git --overwrite
  5. Download the dependencies:
    flutter pub get
  6. Generate the language files:
    flutter pub global run intl_utils:generate
  7. Generate the environment variable class:
    dart run build_runner build
  8. Compile it using either Android Studio's Build -> Flutter -> Build APK feature or
    flutter build apk

If you want to compile the app for iOS, go ahead and try! However, I cannot really help you as I neither have any device running iOS nor an Apple Developer account :/

Pull Requests for iOS fixes are welcome!

Features

Implemented

  • ✔ Authentication using OAuth 1.0
  • ✔ Schedule (might change at some point)
  • ✔ Mensa Plan (might change at some point)
  • ✔ Multiple Mensa Plan Providers (STWNO and OpenMensa)
  • ✔ Offline Mode
  • ✔ Dark Mode
  • ✔ Customization / Preferences
  • Translations
  • ✔ About Page
  • ✔ Home Screen shortcuts
  • ✔ Material 3
  • ✔ Files
  • ✔ Room finder

Planned

  • ❌ Forums
  • ❌ Notifications

Changelog

See here.

Translations

If you want to help translating, drop me an email or file a feature request at the issue tracker to let me know!

Feature Requests and Bugs

Please file feature requests and bugs at the issue tracker.