Skip to content

Frontend for Helium Student Planner

License

Notifications You must be signed in to change notification settings

HeliumEdu/frontend

Coverage Build GitHub License

Helium Frontend

The frontend for Helium, including mobile and web deployments.

Prerequisites

  • Dart (>= 3.10)
  • Flutter (>= 3.38)
  • Android or iOS Emulator

Getting Started

Development

With an emulator running, you can start the app by executing:

make run

To build a development version of the app Android or iOS, execute:

make build-android
make build-ios

Before commits are made, be sure to also run tests.

make test

When running a local web version of the project but hitting prod APIs, CORS will need to be disabled by passing a flag like --web-browser-flag=--disable-web-security to Flutter so it starts the browser with this disabled.

Platform

The backend platform is served from a separate repository and can be found here. If platform has been provisioned and is running locally and you would like to run the frontend against the local backend instead of production, run with --dart-define PROJECT_API_HOST=http://localhost:8000, or use PROJECT_API_HOST=http://localhost:8000 make run.

Note that to reach localhost from within an Android emulator, use 10.0.2.2 instead.