🚀 Flutter Starter

A highly modular, production-ready Flutter starter framework focusing on Clean Architecture, security compliance (RASP), robust environment configurations, and extensive developer tooling.

---

🌟 Key Highlights

• 🏛️ Clean Architecture: Domain, Data, Presentation layers powered by Riverpod and Freezed.
• 🛡️ Enterprise Security (RASP): Real-time monitoring against Jailbreak, Debugging, and Tampering (freerasp).
• 🌐 Network Protocol: Resilient HTTP Client (dio) with intercepts and a detached WebSocket Real-Time Interface.
• 🧪 Comprehensive Automation: End-to-End (patrol), UI/Unit Testing covering all core layers.
• 🎨 1-Click Branding: Native splash screens and launcher icons scaffolded straight from logo.png.
• ⚙️ Powerful Configurations: Layered Fallback configurations allowing Local .env, remote-configs, and dart-defines overrides.

Looking for the complete list of features and tech-stack? Check out the Comprehensive Documentation.

---

🚀 Quick Start

1. Installation

Clone the repository and install dependencies:

git clone <repository-url> my_app
cd my_app
flutter pub get

2. Generate Boilerplate Code

Run the build runner to generate Riverpod providers, JSON serialization, and Freezed unions:

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

3. Native Branding (Optional)

Drop an image to assets/images/logo.png and auto-generate Android and iOS splash screens/icons via:

./scripts/dev/setup_branding.sh

4. Application Configuration

Initialize the local environment settings explicitly:

cp .env.example .env

(Open .env and fill out backend specifics before compiling)

5. Running

flutter run

---

📚 Central Documentation

Rather than cluttering this repository root, we've broken down every system behavior into dedicated guides. Start exploring:

• 📖 Documentation Home (Overview & Modules)
• 🏛️ Architecture Decisions (Clean Architecture & Layers)
• ⚙️ Configuration & Environment Overrides
• 🌐 Network & Real-Time Websockets APIs
• 🛡️ Security, Anti-Tamper & RASP Implementation
• 🧪 Testing & Automated Coverage Checks
• 🚀 Deployment, App Stores & Git Triggers
• 🆕 Creating New Features via CLI Scaffold

---

🤝 Contributing & License

We adhere to standard Conventional Commits and GitHooks to ensure clean delivery. Please review the Contributing Guide to learn how to open Pull Requests properly.

This project is licensed under the MIT License - see the LICENSE file for details.

---

Made with ❤️ using Flutter