PotG

English | 한국어

Architecture

This project is built on Clean Architecture and BLoC pattern.

Architecture Patterns

• Clean Architecture: Each module is separated into data, domain, and presentation layers
• BLoC: State management using BLoC pattern
• Dependency Injection: Dependency injection using get_it and injectable
• Module-based Structure: Independent modules organized by feature

Directory Structure

lib/
├── app/
│   ├── di/               # Dependency Injection configuration
│   ├── modules/          # Feature modules
│   │   ├── auth/         # Authentication
│   │   ├── chat/         # Chat and accounting
│   │   ├── common/       # Common UI/utilities
│   │   ├── core/         # Core infrastructure (network, storage)
│   │   ├── create/       # Pot creation
│   │   ├── device/       # Device information
│   │   ├── list/         # Pot list
│   │   ├── main/         # Main navigation
│   │   ├── socket/       # WebSocket communication
│   │   ├── splash/       # Splash screen
│   │   └── user/         # User profile/settings
│   ├── router.dart       # Routing configuration (auto_route)
│   ├── pot_app.dart      # App entry point
│   └── values/           # Theme, colors, fonts, etc.
└── main.dart             # App starting point

Tech Stack

• State Management: flutter_bloc, bloc_concurrency
• Routing: auto_route
• Networking: dio, retrofit
• Local Storage: hive_ce, flutter_secure_storage
• Code Generation: freezed, json_serializable, injectable
• Internationalization: slang

Download

Contribution

Check Contributing

Setup

Use flutter version manager(fvm) or mise

fvm follows .fvmrc

for mise user, set dart.getFlutterSdkCommand as follows

{
  "dart.getFlutterSdkCommand": {
    "executable": "mise",
    "args": ["where", "flutter"]
  }
}

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Boseong 💻	GwanLiZa 💻	controlZ 📆	Yejin-02 🎨	YeonhyukKim 💻	Hongje Choi 🌍	akrnwl 💻
Hyunseung Ryu 💻	tkjftkjf 💻
Add your contributions

This project follows the all-contributors specification. Contributions of any kind are welcome!