https://github.com/sandromaglione/flutter-supabase-template
Complete configuration of a Flutter app with Supabase: environments, authentication, database, and more.
https://github.com/sandromaglione/flutter-supabase-template
dart flutter flutter-app flutter-examples fpdart functional-programming supabase supabase-auth supabase-db supabase-flutter
Last synced: 17 days ago
JSON representation
Complete configuration of a Flutter app with Supabase: environments, authentication, database, and more.
- Host: GitHub
- URL: https://github.com/sandromaglione/flutter-supabase-template
- Owner: SandroMaglione
- License: mit
- Created: 2022-08-04T10:25:40.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-26T14:47:22.000Z (3 months ago)
- Last Synced: 2025-03-30T06:03:30.427Z (24 days ago)
- Topics: dart, flutter, flutter-app, flutter-examples, fpdart, functional-programming, supabase, supabase-auth, supabase-db, supabase-flutter
- Language: Dart
- Homepage: https://www.sandromaglione.com/techblog/flutter-supabase-authentication-complete-tutorial
- Size: 286 KB
- Stars: 109
- Watchers: 4
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `Flutter + Supabase` app template
This app is a complete setup for a production ready [**Flutter**](https://flutter.dev/) application using [**Supabase**](https://supabase.com/) for [authentication](https://supabase.com/docs/guides/auth), [database](https://supabase.com/docs/guides/database), [storage](https://supabase.com/docs/guides/storage), and [more](https://supabase.com/docs/).
## 🚀 How to run the app
> Make sure you [installed](https://docs.flutter.dev/get-started/install) Flutter and Dart in your machine
1. Clone or fork the repository
```shell
git clone https://github.com/SandroMaglione/flutter-supabase-template.git
```
2. Install the packages required
```shell
flutter pub get
```
3. Run the build command ([`build_runner`](https://pub.dev/packages/build_runner))
```shell
flutter packages pub run build_runner build
```
4. Update [`.vscode/launch.json`](.vscode/launch.json) `args` with your Supabase project URL (`SUPABASE_URL`) and Key (`SUPABASE_ANNON_KEY`):
```json
{
"version": "0.2.0",
"configurations": [
{
"name": "Production",
"request": "launch",
"type": "dart",
"program": "lib/main_prod.dart",
"args": [
"--dart-define=SUPABASE_URL=Url",
"--dart-define=SUPABASE_ANNON_KEY=Key"
]
}
]
}
```
5. Run the app 🚀
## 🧱 Structure of the project
The project is organized in [releases](https://github.com/SandroMaglione/flutter-supabase-template/releases), each containing a specific set of changes for **one feature**:
1. [Environment variables](https://github.com/SandroMaglione/flutter-supabase-template/tree/v1-env-vars)
2. [Routing (`auto_route`)](https://github.com/SandroMaglione/flutter-supabase-template/tree/v2-navigation)
3. [Dependency injection (`injectable`)](https://github.com/SandroMaglione/flutter-supabase-template/tree/v3-dep-injection)
4. [Supabase authentication](https://github.com/SandroMaglione/flutter-supabase-template/tree/v4-supabase-auth)
5. [Supabase database](https://github.com/SandroMaglione/flutter-supabase-template/tree/v5-supabase-database)
6. [Functional programming (`fpdart`)](https://github.com/SandroMaglione/flutter-supabase-template/tree/v6-functional-programming)
You can review each set of changes individually by [**looking at each release**](https://github.com/SandroMaglione/flutter-supabase-template/tags).
> **Note**: Each feature is build on top of the previous one.
### 📃 Packages used ([pubspec.yaml](pubspec.yaml))
- [supabase_flutter](https://pub.dev/packages/supabase_flutter): Supabase SDK for Flutter's applications
- [auto_route](https://pub.dev/packages/auto_route): Routing and navigation using auto-generation
- [injectable](https://pub.dev/packages/injectable) ([get_it](https://pub.dev/packages/get_it)): Dependency injection using auto-generation
- [fpdart](https://pub.dev/packages/fpdart): Functional programming in dart and flutter
> **Note**: This setup is opinionated. There are many other possible solutions and packages to achieve the same (or better) result. It would be interesting to start a discussion about each solution (by [opening new PRs](https://github.com/SandroMaglione/flutter-supabase-template/pulls) implementing other options)
## 👨🏼🏫 Guides and tutorials
Each feature in the app has a [**blog post**](https://www.sandromaglione.com/) associated with it that explains more in the details the changes made:
1. [Environment variables](https://www.sandromaglione.com/articles/how-to-use-environmental-variables-in-flutter)
2. [Routing (`auto_route`)](https://www.sandromaglione.com/articles/how-to-setup-routing-flutter-app)
3. [Dependency injection (`injectable`)](https://www.sandromaglione.com/articles/how_to_implement_dependecy_injection_in_flutter)
4. [Supabase authentication](https://www.sandromaglione.com/articles/flutter-supabase-authentication-complete-tutorial)
5. [Supabase database](https://www.sandromaglione.com/articles/flutter-supabase-database-complete-tutorial)
6. [Functional programming (`fpdart`)](https://www.sandromaglione.com/articles/flutter-dart-functional-programming-fpdart-supabase-app)
## 🛣 Roadmap
- [x] Adding support for [Supabase database](https://supabase.com/docs/guides/database)
- [x] Improving the code using [**fpdart**](https://pub.dev/packages/fpdart) (Functional Programming)
- [ ] Adding support for [Supabase storage](https://supabase.com/docs/guides/storage)
## 🙏🏼 Contribution
Every feedback, feature request, and contribution is gladly accepted:
- Create a [new issue request](https://github.com/SandroMaglione/flutter-supabase-template/issues)
- Create a [new PR for contributions](https://github.com/SandroMaglione/flutter-supabase-template/pulls)