Skip to content
This repository was archived by the owner on Feb 21, 2024. It is now read-only.

Latest commit

 

History

History
76 lines (57 loc) · 4.6 KB

README.md

File metadata and controls

76 lines (57 loc) · 4.6 KB

Very Good Core

Very Good Ventures Very Good Ventures

Developed with 💙 by Very Good Ventures 🦄

coverage style: very good analysis License: MIT

A Very Good Flutter Starter Project created by the Very Good Ventures Team 🦄

💡 Note: This README file is for a developer that wants to use Very Good Core. For contributing information please refer to the CONTRIBUTING file.


What's Included ✨

Out of the box, Very Good Core includes:

  • Cross Platform Support - Built-in support for iOS, Android, Web, and Windows (MacOS/Linux coming soon!)
  • Build Flavors - Multiple flavor support for development, staging, and production
  • Internationalization Support - Internationalization support using synthetic code generation to streamline the development process
  • Sound Null-Safety - No more null-dereference exceptions at runtime. Develop with a sound, static type system.
  • Bloc - Integrated bloc architecture for scalable, testable code which offers a clear separation between business logic and presentation
  • Testing - Unit and Widget Tests with 100% line coverage (Integration Tests coming soon!)
  • Logging - Built-in, extensible logging to capture uncaught Flutter and Dart Exceptions
  • Very Good Analysis - Strict Lint Rules which are used at Very Good Ventures
  • Continuous Integration - Lint, format, test, and enforce code coverage using GitHub Actions
  • ✅ Dependabot Integration

* Learn more at Flutter Starter App: Very Good Core & CLI

Quick Start 🚀

  1. Install a valid Flutter SDK in your local environment. Compatible Flutter SDK versions with Very Good CLI can be found within the Flutter release archive, ensure it has a Dart version compatible with Very Good CLI's Dart version constraint.

  2. Install Very Good CLI:

# 💻 Install Very Good CLI from pub.dev
dart pub global activate very_good_cli
  1. Generate a project using Very Good Core:
# 🚀 Create a new project using Very Good Core
very_good create flutter_app <project-name>

Where <project-name> is the name of your project.

💡 Note: Optionally, you can generate a project using Very Good Core with mason.