Getting Started

This is a guide to help you get started with the project.

Prerequisites

• Flutter installed on your machine
• Git installed on your machine
• FlutterFire Cli installed on your machine for firebase

Installation

There are two version of the app: firebase and supabase. Please clone whichever backend you want to use.

Clone the repository:

1. Firebase Boilerplate:

git clone https://github.com/Flutter-Boilerplate/firebase-boilerplate.git
# Or
git clone https://github.com/Flutter-Boilerplate/supabase-boilerplate.git

Change the directory:

cd firebase-boilerplate
# Or
cd supabase-boilerplate

Install the dependencies & code generation for main app:

flutter pub get && flutter pub run build_runner build --delete-conflicting-outputs

Install the dependencies & code generation for storybook:

cd storybook && flutter pub get && flutter pub run build_runner build --delete-conflicting-outputs

Rename the .env.example file to .env and continue with the setup.

Run the project

Run the project:

flutter run

Done!

If you want to change the package name / app name to something else, check: Change package name