Skip to content
This repository has been archived by the owner on Dec 12, 2024. It is now read-only.

Latest commit

 

History

History
58 lines (43 loc) · 2.58 KB

README.md

File metadata and controls

58 lines (43 loc) · 2.58 KB
Raw

Flutter Starter

Build Status

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)

Quick start

  1. Clone this repo
  2. Use Hermit to install required dependencies (or manually install and setup Flutter and Just)
  3. Run just get to install dependencies
  4. Run just run to run the app

See CONTRIBUTING.md for more details.

TBD theme

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.

Example screens

Counter

First Image Second Image

Todos

First Image Second Image

First Image Second Image

Project resources

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