https://github.com/flutterwiz/bare_bones_flutter

https://github.com/flutterwiz/bare_bones_flutter

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/flutterwiz/bare_bones_flutter
• Owner: FlutterWiz
• License: mit
• Created: 2024-06-20T22:47:43.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2025-02-15T15:03:29.000Z (over 1 year ago)
• Last Synced: 2025-02-15T15:34:41.610Z (over 1 year ago)
• Language: Dart
• Size: 150 KB
• Stars: 9
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# bare_bones_flutter



A Flutter project that serves as a template with essential features for building a robust mobile application.

## ✨ Features

- **Localization**  

  Supports multiple languages to cater to a global audience.

- **MVVM Architecture**  

  Follows the Model-View-ViewModel architecture for a clean and maintainable codebase.

- **Authentication Pages**  

  Includes Sign In and Sign Up pages with text form fields validated using regular expressions.

- **Navigation**  

  Utilizes `go_router` for navigation and `shell_route` for nested routing.

- **Main Branch**  

  No state management, providing the most general case. No ViewModel since there is no functionality yet.

- **Firebase Integration**  

  - Functional Sign In, Sign Out, and Sign Up using Firebase.

  - Built on top of the main branch's features.

  - Incorporates `BLoC` and `Riverpod` for state management.

## 🌿 Branches

- **main**  

  Basic template with the features listed above. No state management or ViewModel.

- **bloc**  

  Extends the main branch with Firebase integration (using BLoC) and additional authentication functionalities.

- **riverpod**  

  Extends the main branch with Firebase integration (using Riverpod) and additional authentication functionalities.

## 🚀 Getting Started

To get started with this project, clone the repository and switch to your desired branch.

## 📁 Project Structure

The project follows a modular structure with a focus on separation of concerns:

    lib/

    ├─ core/

    │  ├─ config/

    │  ├─ constants/

    │  ├─ di/

    │  ├─ init/

    ├─ presentation/

    │  ├─ design_system/

    │  ├─ l10n/

    │  ├─ views/

    ├─ main.dart

## 🛠 Makefile

The project includes a Makefile to manage tasks such as generating localization files and cleaning the project.

### Generate the localization files

```sh

make localization

```