Skip to content

Latest commit

 

History

History
118 lines (90 loc) · 5.64 KB

CONTRIBUTING.md

File metadata and controls

118 lines (90 loc) · 5.64 KB
Raw

Contributing

Getting Started

  1. Setup Flutter
  2. Make sure flutter and dart are both in your PATH. Run dart --version and flutter --version to check.
  3. Clone this repository and cd into it.
  4. Install Melos by running: dart pub global activate melos. Melos is used to manage the Monorepo structure and links all packages.
  5. Run melos bootstrap download all other dependencies (usually flutter pub get is used). If you use Android Studio or VS Code, the files for your IDE are also set up.
  6. Run dart pub get to initialize the StudyU root project. This will apply a consistent lint style to all packages.

If you use Android Studio or VS Code, open the root folder of the project. You should have new run-configurations/tasks added for running the Flutter apps or executing Melos scripts. Use melos <script> to run scripts from the melos.yaml file. You can find more information about Melos in the Melos documentation

Repository Overview

We have different Flutter/Dart packages all contained in this monorepo. The StudyU platform consists out of the following packages:

Dependency packages:

  • Core: shared code for all applications
  • Flutter Common: shared code for all Flutter apps (App, Designer)

Environments

We use .env (environment) files, to specify the environment variables such as Supabase instance and other servers. We have multiple configurations stored under flutter_common/lib/envs/. By default .env (see below) is used, which is our production environment. We can specify the other files by using e.g. --dart-define=STUDYU_ENV=.env.local. This can also be added to the run configuration in Android Studio or VS Code.

flutter build/run android/web/... --dart-define=STUDYU_ENV=.env.dev/.env.prod/.env.local/...

Below is an example for an environment file such as flutter_common/lib/envs/.env.

STUDYU_SUPABASE_URL=https://efeapuvwaxtxnlkzlajv.supabase.co
STUDYU_SUPABASE_PUBLIC_ANON_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoiYW5vbiIsImlhdCI6MTYyNTUwODMyOCwiZXhwIjoxOTQxMDg0MzI4fQ.PUirsx5Zzhj3akaStc5Djid0aAVza3ELoZ5XUTqM91A
STUDYU_PROJECT_GENERATOR_URL=https://studyu-project-generator-2zro3rzera-ew.a.run.app
STUDYU_APP_URL="https://app.studyu.health/"
STUDYU_DESIGNER_URL="https://designer.studyu.health/"

Additionally, we have the following environment files:

  • .env: Production database used by default
  • .env.dev: Development database used by dev branch
  • .env.local: Local database for a custom Supabase instance (used by the Supabase CLI)

Ideally, we should only use the development database or a local one for all our development work.

Coding on core

Changes to the models in the core package requires to perform a re-generation of the JSON IO code. The toolchain we use for this consists of build_runner and json_serializable.

After you made changes to the models, update the generated IO code by running melos run generate.

Contrary to most recommendations, we commit those generated files (*.g.dart) to Git. This is needed, because core is a dependency of the StudyU App and the StudyU Designer and dependencies need to have all files generated, when being imported.

Code Style

We use the Effective Dart guidelines for Dart and Flutter. Run melos format to format your code and melos analyze to check for any issues. For commit messages, we use the Conventional Commits format. For any new features or bug fixes, create a new branch and open a pull request.

Please make sure to follow these guidelines when contributing to the project.

Flutter Version Management

The StudyU monorepo uses the FVM tool to manage the Flutter SDK version. This allows us to have a consistent Flutter version across all packages. The Flutter SDK version is specified in the .fvm file in the root directory. To install the Flutter SDK version, run fvm install in the root directory. You might also want to integrate FVM within your IDE. For Android Studio you can change the Flutter SDK path in the settings for the Flutter plugin. Open the Android Studio settings and navigate to Languages & Frameworks -> Flutter -> Flutter SDK path and set the path to the FVM Flutter SDK (<path to the studyu repository>/.fvm/flutter_sdk). For VS Code, have a look at the FVM documentation.

Using FVM with melos requires setting the MELOS_SDK_PATH environment variable to the path of the FVM Flutter SDK. This can be done by running export MELOS_SDK_PATH=.fvm/flutter_sdk in the terminal. This is needed to ensure that melos uses the correct Flutter SDK version.

Database and Backend

We are using a self-hosted instance of Supabase as a Backend-as-a-Service provider. Supabase provides different backend services such as a database, API, authentication, storage service all based around PostgreSQL and other FOSS. Since Supabase is open-source, we are hosting our own instance to ensure data privacy and security. For development purposes, Supabase can be self-hosted by using the Supabase CLI. Have a look into the /supabase/README.md file for a guide on how to run the Supabase CLI for StudyU.