A starter project for Flutter apps. This start setups up best practices for Flutter apps, including:
- Localization
- Theming
- CI/CD
- Testing
- Code generation
- Dependency injection and state management (via Riverpod)
- Linting and formatting
- Separate application layers implemented via sub-packages (e.g.
services
)
- Clone this repo
- Use Hermit to install required dependencies (or manually install and setup Flutter and Just)
- Run
just get
to install dependencies - Run
just run
to run the app
See CONTRIBUTING.md for more details.
The theme is defined in lib/shared/theme.dart
. It is a ThemeData
object that is used by the MaterialApp
and setup during app initialization in lib/features/app/app.dart
.
Note: The theme is currently a work in progress. In the future, we might move the theme out to a dedicated TBD Design System package.
Resource | Description |
---|---|
CODEOWNERS | Outlines the project lead(s) |
CODE_OF_CONDUCT.md | Expected behavior for project contributors, promoting a welcoming environment |
CONTRIBUTING.md | Developer guide to build, test, run, access CI, chat, discuss, file issues |
GOVERNANCE.md | Project governance |
LICENSE | Apache License, Version 2.0 |