diff --git a/README.md b/README.md index a27cb9c..6062b09 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,6 @@ Build Status Stars Forks - Under Development License

@@ -26,13 +25,13 @@ - Launch Dashboard + Generate Your Project - Read Docs + Read Docs @@ -45,68 +44,84 @@ --- -## πŸ›οΈ The Architecture of Speed +**No installation required.** Open **[flutterinit.com](https://flutterinit.com)** and generate. -**FlutterInit** is an open-source project designed to eliminate the "initial drag" of Flutter development. It provides a highly opinionated yet flexible scaffolding system that maps your architectural vision to a production-ready codebase in seconds. +## πŸ›οΈ What is FlutterInit? -### 🎯 Why use FlutterInit? -- **Elite Quality**: Follows `flutter_lints`, SOLID principles, and validated against a comprehensive matrix of critical architectural combinations. -- **Extreme Speed**: From a blank screen to a running app with routing & state in < 60s. -- **Enterprise DNA**: Pre-configured with logging, error handling, and environment management. +FlutterInit is a web-based scaffolding engine for Flutter. + +You visit flutterinit.com, pick your architecture, state management, backend, and navigation style β€” and FlutterInit generates a production-ready Flutter project as a downloadable zip. + +No templates to clone. No CLI to install. Open the dashboard, configure, download, build. --- -## πŸ› οΈ Prerequisites +## πŸ”„ How It Works -Ensure your environment meets these requirements before starting: +1. Open **[flutterinit.com](https://flutterinit.com)** +2. Name your project and choose your options: + - **Architecture:** Clean Architecture, MVVM, Feature-First + - **State Management:** Riverpod, Bloc, Provider, GetX, MobX + - **Backend:** Firebase, Supabase, Appwrite, or none + - **Navigation:** GoRouter, AutoRoute, or imperative + - **Design:** Material 3, dark mode, ScreenUtil + - **Extras:** localization, logging, permissions, image picker, etc. +3. Click **"Generate Project"** +4. Download the `.zip` +5. Unzip β†’ `cd` into the folder β†’ run `flutter pub get` β†’ `flutter run` + +--- -* **Flutter SDK**: `^3.5.0` (Latest Stable recommended) -* **Runtime**: [Node.js](https://nodejs.org/) `^20.0.0` or [Bun](https://bun.sh/) `^1.1.0` -* **Platforms**: macOS, Windows (WSL2 recommended), or Linux +## πŸ“¦ What's Inside the Generated Project? + +Every generated project includes: +- Folder structure matching your chosen architecture +- Routing pre-configured with your chosen navigation package +- State management boilerplate set up and ready to extend +- `pubspec.yaml` with all chosen dependencies declared +- Environment config (`.env` support via `flutter_dotenv`) +- Logging, error handling, and base network layer (if Dio selected) +- Material 3 theme with dark mode support +- AI context files: `CLAUDE.md`, `AGENTS.md`, `.cursorrules` β€” pre-written for your exact stack so AI editors have full project context from day one + +--- ## ⚑ Quick Start -Get your professional Flutter scaffold running in 3 steps: +**No installation required.** + +1. Go to **[flutterinit.com](https://flutterinit.com)** +2. Configure your stack using the visual dashboard +3. Click **Generate Project** and download your `.zip` +4. Unzip and run: -1. **Clone & Install**: - ```bash - git clone https://github.com/Arjun544/flutter_init.git - cd flutter_init && bun install - ``` -2. **Launch Dashboard**: - ```bash - bun run dev - ``` -3. **Generate**: Open `http://localhost:3000`, pick your stack, and download your `.zip`. +```bash +cd your_project_name +flutter pub get +flutter run +``` + +That's it. Your project is ready. --- -## ✨ Features (Elevated) - - - - - - - - - - -
-

πŸš€ Zero Boilerplate

-

Forget the 4-hour setup. We generate the folder structure, base classes, and core utilities so you can focus on building features.

- 		-

πŸ—οΈ Architecture First

-

Optimized for Clean Architecture, MVVM, and Feature-First structures. The engine adapts to your team's mental model.

-
-

🎨 Design System Ready

-

Material 3 tokens, dark mode support, and responsive scaling (via ScreenUtil) are baked into every scaffold.

- 		-

βš™οΈ Industrial Strength

-

Includes an intuitive Web Dashboard for managing your project lifecycle from initialization to deployment.

-
- -### 🧩 Support Matrix +## πŸ› οΈ Prerequisites + +### To use a generated project +- Flutter SDK `^3.5.0` ([install guide](https://docs.flutter.dev/get-started/install)) + +No other tools required. FlutterInit runs in your browser. + +### To run FlutterInit locally (contributors only) +- Node.js `^20.0.0` or Bun `^1.1.0` +- Flutter SDK (for running `dart analyze` on generated output during testing) +- See [CONTRIBUTING.md](CONTRIBUTING.md) for full setup + +--- + +## 🧩 Support Matrix + +You configure all of these options directly in the dashboard β€” no config files, no flags. The matrix below shows every supported option. | Category | Supported Options | | :--- | :--- | @@ -123,8 +138,22 @@ Get your professional Flutter scaffold running in 3 steps: --- +## πŸ€– AI-Ready From Day One + +Every generated project includes pre-written AI context files tailored to your exact stack: + +- `CLAUDE.md` β€” for Claude Code +- `AGENTS.md` β€” for Codex and other agent workflows +- `.cursor/rules/flutter-project.mdc` β€” for Cursor + +These files give your AI editor full context about your architecture, state management pattern, folder structure, and conventions β€” without you having to write a single prompt. + +--- + ## πŸ“š Documentation +New to FlutterInit? Start with the [Getting Started Guide](docs/getting-started.md). + Explore our technical guides to understand the architecture and flags: * **[Getting Started Guide](docs/getting-started.md)**: From download to first successful run. @@ -137,26 +166,35 @@ Explore our technical guides to understand the architecture and flags: --- -## 🀝 Contribution-Based Growth +## πŸ—ΊοΈ Roadmap + +We use GitHub Projects to track what's in progress and what's coming next. -This repository is built on the principle of **Contribution Based Evolution**. We don't just want users; we want architects. +πŸ‘‰ [View the FlutterInit Roadmap](https://github.com/users/Arjun544/projects/1) -- **Submit Patterns**: Add architectural overlays (Layer-First, MVC, MVVM) to the `templates/` directory. -- **Refine the Core**: Improve the Next.js visual wizard or generator logic in `app/lib/`. -- **Bug Hunter**: Help us identify and fix synchronization issues in the template dev loop. -- **Template Dev**: Learn our real-time [Template Dev workflow](docs/template-development.md). +Want to contribute? Pick up any open issue labeled [`good first issue`](https://github.com/Arjun544/flutter_init/issues?q=label%3A%22good+first+issue%22). -> [!TIP] -> Every contributor who gets a PR merged receives a special place in our contributors' hall of fame. --- -## πŸ—ΊοΈ Roadmap +## πŸ§‘β€πŸ’» Running FlutterInit Locally (Contributors) -We use GitHub Projects to track what's in progress and what's coming next. +If you want to contribute to FlutterInit's engine or templates, you'll need to run it locally. -πŸ‘‰ [View the FlutterInit Roadmap](https://github.com/users/Arjun544/projects/1) +**Clone & install:** +```bash +git clone https://github.com/Arjun544/flutter_init.git +cd flutter_init +bun install +``` -Want to contribute? Pick up any open issue labeled [`good first issue`](https://github.com/Arjun544/flutter_init/issues?q=label%3A%22good+first+issue%22). +**Start the development server:** +```bash +bun run dev +``` + +Open `http://localhost:3000` to use the local dashboard. + +See [CONTRIBUTING.md](CONTRIBUTING.md) and the [Architecture Overview](docs/architecture.md) for how the Handlebars templating engine works. --- diff --git a/docs/testing.md b/docs/testing.md index 2339e0e..2febcc6 100644 --- a/docs/testing.md +++ b/docs/testing.md @@ -226,7 +226,7 @@ When a test fails in GitHub Actions, these detailed logs are preserved as artifa If a specific combination fails (e.g., `layer-first|none|none|auto_route`): ```bash # Generate and debug a specific combo -bun scripts/validate-dart.ts --combo "layer-first|none|none|auto_route" --keep-output +bun scripts/validate-dart.ts --combo "mvvm|bloc|supabase|auto_route" --keep-output ``` Inspect the generated code in `./.temp/flutterinit/` and run `dart analyze` manually. diff --git a/templates/flutter/base/lib/src/config/app_config.dart.hbs b/templates/flutter/base/lib/src/config/app_config.dart.hbs index 3976328..e2e967f 100644 --- a/templates/flutter/base/lib/src/config/app_config.dart.hbs +++ b/templates/flutter/base/lib/src/config/app_config.dart.hbs @@ -59,7 +59,7 @@ class AppConfig { {{#if (eq backend.provider "supabase")}} await Supabase.initialize( url: dotenv.get('SUPABASE_URL', fallback: 'https://YOUR-PROJECT.supabase.co'), - anonKey: dotenv.get('SUPABASE_ANON_KEY', fallback: 'YOUR-ANON-KEY'), + publishableKey: dotenv.get('SUPABASE_ANON_KEY', fallback: 'YOUR-ANON-KEY'), ); supabase = Supabase.instance.client; {{/if}}