/template-flutter-project

A template for Flutter projects

Primary LanguageDartMIT LicenseMIT

Flutter Project Template

Project Logo

Tests Code Coverage Code Quality Flutter Dart Documentation License Makefile

This is a template repository for creating new Flutter projects. It includes a basic structure, a Makefile for common developmental tasks, and a set of GitHub Actions workflows for running tests and analysis.

Features

  • Makefile: for managing common tasks like testing, linting, and formatting.
  • GitHub Actions: for running tests and static analysis.
  • Strict Linting: Configured with a strong set of analysis rules for high-quality code.
  • Scalable Architecture: A pre-defined directory structure for building scalable apps.

Prerequisites

  • Flutter SDK: Installed system-wide, for example via snap.
  • GNU Make
  • Python >=3.10 and pip for installing pre-commit.

Usage

  1. Use the Use this template button on GitHub to create a new repository.
  2. Install project dependencies: 
    make install
  3. Set up the Git hooks (optional but recommended): 
    make setup-hooks
  4. Run make help to see all available commands.

Contributing

See CONTRIBUTING.md for details on how to make a contribution.

License

This template is licensed under the MIT License (LICENSE or https://opensource.org/licenses/MIT)