https://github.com/Elementary-team/flutter-elementary

This is a home to a family of Elementary library packages.
https://github.com/Elementary-team/flutter-elementary

architecture dart flutter mvvm

Last synced: 7 days ago
JSON representation

This is a home to a family of Elementary library packages.

• Host: GitHub
• URL: https://github.com/Elementary-team/flutter-elementary
• Owner: Elementary-team
• License: mit
• Created: 2021-10-14T12:26:00.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-29T10:41:44.000Z (about 1 month ago)
• Last Synced: 2024-10-29T14:20:03.717Z (12 days ago)
• Topics: architecture, dart, flutter, mvvm
• Language: Dart
• Homepage:
• Size: 2.96 MB
• Stars: 133
• Watchers: 5
• Forks: 45
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Flutter Elementary repository

###



    



###



    

    

    

    

    

    

    

    



## Description

This repository is a home to packages and tools from the Elementary library family.

| Package                                                                                                                    |                                                                Version                                                                 |

|----------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------:|

| [elementary](https://github.com/Elementary-team/flutter-elementary/tree/main/packages/elementary)                          |        [![Pub Version](https://img.shields.io/pub/v/elementary?logo=dart&logoColor=white)](https://pub.dev/packages/elementary)        |

| [elementary_helper](https://github.com/Elementary-team/flutter-elementary/tree/main/packages/elementary_helper)            | [![Pub Version](https://img.shields.io/pub/v/elementary_helper?logo=dart&logoColor=white)](https://pub.dev/packages/elementary_helper) |

| [elementary_test](https://github.com/Elementary-team/flutter-elementary/tree/main/packages/elementary_test)                |   [![Pub Version](https://img.shields.io/pub/v/elementary_test?logo=dart&logoColor=white)](https://pub.dev/packages/elementary_test)   |

| [elementary_cli](https://github.com/Elementary-team/flutter-elementary/tree/main/packages/elementary_tools/elementary_cli) |    [![Pub Version](https://img.shields.io/pub/v/elementary_cli?logo=dart&logoColor=white)](https://pub.dev/packages/elementary_cli)    |

## Elementary Overview

Elementary is a simple and reliable way to build applications with MVVM in Flutter. Benefits of using Elementary include:

- **Maximum Flutter-like**: You don't need to spend a lot of time learning the library if you are already familiar with the standard Flutter approaches.

- **Code separation by responsibility**: Splitting code into different layers reduces coupling, making the code simpler and more readable.

- **High testability**: All layers, from widgets to business logic, are highly testable.

- **Team efficiency**: It boosts speed for teams consisting of more than one person, due to the easy sharing of independent task parts among team members.

## Documentation

Learn more at our website with [documentation](https://documentation.elementaryteam.dev/).

## Environment

To reduce the amount of boilerplate and manual work, Elementary offers a few options:

- [elementary_cli](https://pub.dev/packages/elementary_cli): A command line utility that helps with boilerplate generation.

- [Plugin for IntelliJ](https://plugins.jetbrains.com/plugin/18099-elementary): A plugin for the IntelliJ IDE family, based on elementary_cli.

- [Plugin for VSCode](https://marketplace.visualstudio.com/items?itemName=ElementaryTeam.elementary): A plugin for VSCode, based on elementary_cli.

- [elementary brick](https://brickhub.dev/bricks/elementary): A command line utility that helps with boilerplate generation, based on Mason.

## Examples

- [Country](https://github.com/Elementary-team/flutter-elementary/tree/main/examples/country): A general example of how to use Elementary for development.

- [Elementary with Redux](https://github.com/Elementary-team/flutter-elementary/tree/main/examples/elementary_redux): An example of how to use Elementary with Redux.

- [Profile](https://github.com/Elementary-team/flutter-elementary/tree/main/examples/profile): An example demonstrating a feature that spans separate screens, and how to use Elementary with Bloc.

## Maintainer



    


        

        
Mikhail Zotyev

    




## Contributors thanks

Big thanks to all these people, who put their effort into helping the project.

![contributors](https://contributors-img.firebaseapp.com/image?repo=Elementary-team/flutter-elementary)



Special thanks to:

[Dmitry Krutskikh](https://github.com/dkrutskikh), [Konoshenko Vlad](https://github.com/vlkonoshenko), and 

[Denis Grafov](https://github.com/grafovdenis) for the early adoption and the first production feedback;

[Alex Bukin](https://github.com/AlexeyBukin) for IDE plugins;

All members of the Surf Flutter Team for actively using and providing feedback.

## Sponsorship

Special sponsor of the project:







For all questions regarding sponsorship/collaboration connect with [Mikhail Zotyev](https://github.com/MbIXjkee).