webeautiful / flutter_starter

Boilerplate (seed) project for creating Flutter apps with go_router, Riverpod, Dio and Widgetbook

flutter_starter

flutter_starter is a simple scaffold based on Flutter for quick use with go_router, Riverpod, Dio.

Features

• ⚡️ Flutter, Dart - Build apps for any screen

• 🗂 Router via go_router

• 🍍 State Management via Riverpod

• 🎢 Restful api via Dio

• 📦 Persistent storage via shared_preferences

• 🌍 Localization via l10n

• 🎨 Light/Dark Theme

• 🐭 JSON convert to DartBean - an Android Studio plugin

• 📃 Pretty logs via logger

• 🔎 Storybook for Flutter via Widgetbook

• 😃 Splash Screen via flutter_native_splash

• ♈ Setting AppName and BundleId via rename

• 🦾 Null-Safety, of course

Requirements

• Flutter v3.10+
• Dart v3.0+
• VS Code
• Android Studio

Getting Started

Just clone the repo, install project dependencies, and start hacking:

$ git clone https://github.com/webeautiful/flutter_starter my_project
$ cd ./my_project/lib
$ flutter pub get

Checklist

When you use this template, try follow the checklist to update your info properly

• Restful api via Dio
• toast via flutter_smart_dialog
• Splash Screen via flutter_native_splash
• Encapsulate storage singletons

And, enjoy :)

Why

I have created several Flutter apps recently. Setting the configs up is kinda the bottleneck for me to make the ideas simply come true within a very short time.

So I made this starter template for myself to create apps more easily, along with some good practices that I have learned from making those apps. It's strongly opinionated, but feel free to tweak it or even maintain your own forks.