README.md

Gruene App

Contents

• Setup
• Initial Setup
• Run the App
• Conventions
• CI/CD

Setup

Initial Setup

1. Install the Android SDK via the Android plugin or Android Studio
2. Install fvm (flutter version manager)
3. Install flutter

fvm install

4. [Optional] Open IntelliJ settings and
   • Install the Android plugin and set the Android SDK path
   • Install the Dart plugin and set the Dart SDK path
   • Install the Flutter plugin and set the Flutter SDK path

API Setup

There are two options to connect your app to the Grüne API for development:

• Connect to the staging Grüne API using an access token
• Connect to the locally running Grüne API

Staging Grüne API Setup

1. Generate an access token for the staging Grüne API
2. Copy staging environment

cp .env.staging .env

3. Add your GRUENE_API_ACCESS_TOKEN to .env

Local Grüne API Setup

0. Make sure the Grüne API is setup and running. For documentation on the necessary steps, refer to the Grüne API README.
1. Configure local environment

cp .env.dev .env

Run the App

1. Update translations

fvm dart run slang

2. Run build runner to update API definitions

fvm dart run build_runner build

3. [Optional] If you are running the app on a real device and use a local Grüne API, you need to expose the ports:

adb reverse tcp:8080 tcp:8080 && adb reverse tcp:5000 tcp:5000

4. Run the app (development)