CONTRIBUTING.md

Getting started

1. Clone this project
2. Setup Database

Setup Database (Supabase)

Detailed instructions can be found here: Supabase Local Development

Prerequisites: Supabase Prerequisites

Steps:

1. Run supabase start in package root directory to start a local supabase emulator.
2. Run supabase db reset to run migrations and fill local database with seed data.
3. Create supabase project.
4. Link your CLI to your project.
5. Run supabase db push to deploy local database migrations to remote database.

In your app you need to create a SupabaseConfig-instance with your credentials to pass it to the package.

final supabaseConfig = SupabaseConfig(<supabaseUrl>, <supabaseKey>)

Values for local database: After running supabase start you get your credentials:

supabaseUrl = API URL
supabaseKey = anon key

Values for remote database: Go to your project on Supabase and then go to API > Authentication to find your credentials there.

Testing

1. Start the test database
2. Set your local Supabase credentials in test/supabase_config.dart
3. Run the tests with flutter test