What is Neuma?
Derived from the Greek word "pneuma" meaning breath or spirit, Neuma Base Flutter is designed to bring life into your Flutter projects without getting in your way
It's a lightweight yet scalable Flutter starter with a feature-first architecture and a DDD-inspired folder structure -- perfect for rapid prototyping, real-world app development, and clean production-ready codebases.
Technologies
Project Structure
lib/
+-- core/ # App-wide configurations and helpers
| +-- constants/ # App constants (colors, strings, keys)
| +-- services/ # Core service implementations (e.g., navigation, logging)
| +-- theme/ # Centralized theming
| +-- utils/ # Utility functions
|
+-- data/ # Low-level data layer (network, DB, etc.)
| +-- api/ # API clients and endpoints
| +-- database/ # Local DB interfaces
| +-- models/ # DTOs and data representations
| +-- repositories/ # Data sources implementation
|
+-- features/ # Modular feature-first structure
| +-- home/
| | +-- domain/ # Entities, usecases, abstract repos
| | +-- presentation/ # UI widgets, screens
| | +-- state/ # State management (e.g. cubits/providers)
| +-- profile/ # (Placeholder for other features)
|
+-- routing/ # App routing setup
|
+-- shared/ # Shared UI & logic across features
| +-- dialogs/
| +-- extensions/
| +-- widgets/
|
+-- tests/ # Testing files and mocks
|
+-- main.dart # Entry point
+-- core/ # App-wide configurations and helpers
| +-- constants/ # App constants (colors, strings, keys)
| +-- services/ # Core service implementations (e.g., navigation, logging)
| +-- theme/ # Centralized theming
| +-- utils/ # Utility functions
|
+-- data/ # Low-level data layer (network, DB, etc.)
| +-- api/ # API clients and endpoints
| +-- database/ # Local DB interfaces
| +-- models/ # DTOs and data representations
| +-- repositories/ # Data sources implementation
|
+-- features/ # Modular feature-first structure
| +-- home/
| | +-- domain/ # Entities, usecases, abstract repos
| | +-- presentation/ # UI widgets, screens
| | +-- state/ # State management (e.g. cubits/providers)
| +-- profile/ # (Placeholder for other features)
|
+-- routing/ # App routing setup
|
+-- shared/ # Shared UI & logic across features
| +-- dialogs/
| +-- extensions/
| +-- widgets/
|
+-- tests/ # Testing files and mocks
|
+-- main.dart # Entry point
Getting Started
1. Clone the repo
git clone https://github.com/abelherl/neuma-base-flutter.git
cd neuma-base-flutter
cd neuma-base-flutter
2. Install packages
flutter pub get
3. Run the app
flutter run
4. (Optional) Update README and LICENSE file
You can alter this LICENSE and README file for your project if needed. You can also choose your own license here.
Future Plans
- Clean folder separation with feature-first approach
- Integrate a mason template for CLI bootstrapping
- Multiple base templates (e.g. Bloc, Provider, Riverpod, Getx)
- Pre-setup CLI toolchain
License
Licensed under the MIT License