Skip to content

sonalmaniya/FlutterStarterKit

Repository files navigation

Flutter Starter Kit

Flutter Starter Kit is a comprehensive template to kickstart your Flutter applications. It offers a clean architecture, well-organized folder structure, and pre-configured libraries. Whether you're a beginner or an experienced developer, this kit helps you focus on building beautiful apps faster.


🚀 Getting Started

This project is a starting point for a Flutter application.

✅ Prerequisites


🔧 Installation

  1. Clone the repository:

    git clone https://github.com/sonalmaniya/FlutterStarterKit.git
  2. Navigate to the project directory:

    cd FlutterStarterKit
  3. Install dependencies:

    flutter pub get
  4. Run the app:

    flutter run

📦 Libraries & Tools Used

Purpose Package
Routing auto_route
Connectivity connectivity_plus
Networking dio
Encryption encrypt
Equality equatable
State Management (BLoC) flutter_bloc
Environment Handling flutter_dotenv
Localization flutter_localization
Dependency Injection get_it
Persistent Storage shared_preferences

📁 Directory Structure

FlutterStarterKit/
├── android/
├── ios/
├── lib/
│   ├── config/
│   ├── widgets/
│   │   ├── custom_button.dart
│   │   └── user_avatar.dart
│   ├── constants/
│   │   ├── enums.dart
│   │   ├── image_constant.dart
│   │   └── pref_constants.dart
│   ├── network/
│   ├── navigation/
│   │   ├── observer/
│   │   │   └── app_navigator_observer.dart
│   │   └── routes/
│   │       ├── app_router_imports.dart
│   │       └── app_routes.dart
│   ├── resource/
│   │   ├── dimension/
│   │   └── styles/
│   ├── utils/
│   ├── presentation/
│   │   └── news/
│   │       ├── bloc/
│   │       │   ├── news_bloc.dart
│   │       │   ├── news_event.dart
│   │       │   └── news_state.dart
│   │       ├── models/
│   │       │   └── news_model.dart
│   │       ├── api/
│   │       │   └── news_api.dart
│   │       ├── repository/
│   │       │   └── news_repository.dart
│   │       ├── widget/
│   │       │   └── news_screen.dart
│   │       └── view/
│   │           ├── widget/
│   │           └── news_screen.dart
│   └── main.dart
├── test/
├── pubspec.yaml
├── README.md

🧰 Custom Commands

✅ Setup Pre-commit Hooks (with Husky)

dart run husky install

🔁 Run Custom Script Commands

rps <command_name>

Available Commands:

  • Generate Locales:

    rps gen_locale
  • Generate Navigation Routes:

    rps nav_generator
  • Setup Development Environment:

    rps setup_dev_env

🔮 Upcoming Features

  • Theme support (light/dark mode)
  • Logging system
  • CI/CD integration
  • Error boundary and reporting

👩‍💻 Author

Sonal Maniya
GitHub · LinkedIn


📄 License

This project is licensed under the MIT License.

Releases

No releases published

Packages

No packages published