Get Started
A comprehensive guide to installing and configuring your Floot application.
Prerequisites
In order to start using Floot starter kit, here are the required tools to have installed on your machine:
- Flutter
- Docker
- Supabase CLI
- Deno
- Stripe CLI
- Only required if using Stripe as your payment provider.
Floot CLI
Floot CLI is a command-line utility designed to simplify the creation and management of Floot projects. It offers commands for initializing new projects and handling different components of your Floot application.
Quick Install
We recommend installing floot_cli from official Github private repo.
dart pub global activate --source=git git@github.com:flootdotdev/floot-cli.gitdart pub global activate --source=git https://github.com/flootdotdev/floot-cli.gitAlternatively, floot_cli can be installed locally.
Why install locally?
If you do not have the lifetime updates pack, your access to the private GitHub repo will end at your anniversary date. After that, you won't be able to activate the CLI from GitHub again. To avoid any issues, we recommend keeping a local copy of the CLI before your access expires. If you miss the download window, just contact us, we’ll be happy to provide you with the latest version available before your anniversary.
Clone the repo.
git clone git@github.com:flootdotdev/floot-cli.git floot_cligit clone https://github.com/flootdotdev/floot-cli.git floot_cliActivate it locally.
dart pub global activate --source=path <path/to/floot_cli>Check Installation
Once you have successfully installed the floot_cli you can verify your setup by running this command in your terminal.
floot --helpPossible Installation Issue
You may encounter an error running floot if the Dart Pub cache
directory is not in your system PATH. Solution:
Add the Pub cache to your PATH environment variable.
If floot_cli was installed correctly, you should see something similar to the following output:
CLI of Floot starter kit.
Usage: floot <command> [arguments]
Global options:
-h, --help Print this usage information.
-v, --version Print the current version.
--[no-]verbose Noisy logging, including all shell commands executed.
Available commands: ...Create Floot Project
Once floot_cli is installed, we can use the create command to create a new Floot project.
Create a new project in the current directory.
It is recommended to run this command with the
--orgflag to specify your organization, which will help in managing your projects more effectively (e.g.,floot create my_app --org com.acme).
floot create <project_name>Navigate to the project directory.
cd <project_name>After navigating to your project directory, open a new terminal window and start the Supabase local instance for your project.
Before you proceed
Ensure Docker is running in the background before starting Supabase. Note: Initial startup may take several minutes.
cd supabase
supabase start- Serve the functions locally:
supabase functions serve --env-file .env.local --import-map ./functions/deno.json --no-verify-jwtIn your original terminal window, run the Flutter project:
flutter run --dart-define-from-file .env.local