slidy 1.1.0+1

CLI package manager and template for Flutter. Generate Modules, Pages, Widgets and BLoCs

Slidy - Why to use?

Slidy's goal is to help you structure your project in a standardized way. Organizing your app in Modules formed by pages, repositories, widgets, BloCs, and also create unit tests automatically. The Module gives you a easier way to inject dependencies and blocs, including automatic dispose. Also helps you installing the dependencies and packages, updating and removing them. The best is that you can do all of this running a single command.

Motivations

We realized that the project pattern absence is affecting the productivity of most developers, so we're proposing a development pattern along with a tool that imitates NPM (NodeJS) functionality as well as template generation capabilities (similar to Scaffold ).

About the Proposed Pattern

The structure that slidy offers you, it's similar to MVC, where a page keeps it's own business logic classes(BloC).

We recommend you to use bloc_pattern when structuring with slidy. It offers you the module structure(extending the ModuleWidget) and dependency/bloc injection, or you will probably get an error.

To understand bloc_pattern package, take a look at the README.

We also use the Repository Pattern, so the folder structure it's organized in local modules and a global module. The dependencies(repositories, BloCs, models, etc) can be accessed throughout the application.

Sample folder structure generated by slidy:

Installation

1. You need to have the Dart SDK installed.
2. Activate the slidy using the pub:

   pub global activate slidy
   

3. Type slidy --version if it returns the version it's working.

Commands:

upgrade:

Updates slidy's version:

slidy upgrade

start:

Create the basic structure of your project (make sure that your "lib" folder it's empty).

slidy start

run:

Runs the scripts in pubspect.yaml:

slidy run open_folder

install:

Installs or update the packages in dependencies:

slidy install rxdart dio bloc_pattern

or you can just use the i command (both are the same)

slidy i rxdart dio bloc_pattern

Install packages as dev_dependency:

slidy i flutter_launcher_icons --dev

uninstall:

Removes a package

slidy uninstall dio 

You can also remove a dev_dependency using the flag --dev

generate:

Creates a module, page, widget or repository including its BloC class.

NOTE: You can replace "g" with "generate" command.

Creates a new module:

slidy g module folder_name

Creates a new page + BloC:

slidy g page folder_name/pages

Creates a new widget + BloC:

slidy g widget folder_name/widgets

NOTE: You can create a page or widget using its respective BLoC using the flag -b

Create a new repository

slidy g r folder_name/repositories

You can also use "repository" in "r"'s place, but it will have the same function.

Unit Tests:

Generate unit tests on the test folder for you.

slidy test folder_name/

======= Para ver em Português clique aqui

Slidy

This CLI consists of a way to assemble your project structured by modules, pages, repositories, widgets always following the standards of good practices that has been applied by the community flutter in bigger and more structured projects. It also provides the libraries manager (libs or pubs) with it you can install multiple libraries with just one command line and even remove and update.

Migration from v0.2.1 to v1.0.0:

Some commands have been improved for ease of usability for example the module, page and widget generation command have been shortened.

//vesion 0.2.1
slidy generate module page/search/search

//version 1.0.0
slidy generate module page/search

The main folder is no longer called "src" but "app"

Motivations

We realized that the lack of a project pattern is affecting the productivity of several developers at that initial moment, so we are proposing a development pattern along with a tool that imitates NPM (NodeJS) functionality as well as template generation capabilities (similar to Scaffold ).

About the Proposed Pattern.

We adopted the BLoC standard for business rule in a structure similar to MVC, where a page or widget has one or more BLoC to manage its business rule.

We are using the module structure and dependency injection of the package bloc_pattern. Read the bloc_pattern README to familiarize yourself with the concept of dependency injection, BLoC Provider and modules.

For services and provider we use the Repository Pattern.

In this way our folder structure is organized into local modules and a global module, as well as models, repositories and BLoC`s that can be accessed throughout the application in the shared folder.

Sample folder structure generated by slidy:

Installation

• You need to have the Dart SDK installed. If you do not have download now.
• Now just activate the slidy using the pub:

pub global activate slidy

• Type slidy --version - if you return the slidy version you can consider the complete installation.
• To update the slidy just use the command:

slidy upgrade

Ready now you can enjoy this new world.

Commands:

start: Create a basic structure for your project (confirm that you have no data in the "lib" folder).

slidy start

run: Run scripts placed in the "scripts" parameter in pubspect.yaml

slidy run open_folder

Install: Install (or update) a new package or packages:

slidy install rxdart dio bloc_pattern

You can also install a package as dev_dependency using the flag --dev

slidy i mockito --dev

remove a package

slidy uninstall dio 

You can also remove a dev_dependency using the flag --dev

Generate:

Create a module, page, widget or repository according to the option.

Options:

Creates a new module with slidy generate module:

slidy generate module manager/product

Creates a new page and its respective Bloc

slidy generate page manager/product/pages/add_product

Creates a new widget and its respective Bloc:

slidy generate widget manager/product/widgets/product_detail

NOTE: You can create a page or widget with your respective BLoC using the flag -b

Create a new repository

slidy g r manager/product/repositories/product

Common errors:

Windows:

If you got this error when trying to run the pub global activate slidy, then you will have to set the environment variables manually:

In windows search, write: Edit System Variables

Then click at Environment Variables

Go to Path

Then click in New and add the path that appeared on your console.

For more information, watch this video.

Join our Flutterando Telegram Group!

If you find out with the above error, when trying to run or the pub global activate slidy, then you will have to put in the environment variables manually:

Go to windows search and search for: Edit System variable

After click in Environment Variables

Search forPath

Then click in New and add the path that appeared on your console in case here is : C:\Users\1513 MX5-7\AppData\Roaming\Pub\Cache\Bin after that just restart your CMD.

For more details Telegram Group Flutterando