Fork from Slidy, a CLI package manager and template for Flutter made by Flutterando This package uses http rather dio, easy_bloc rather bloc_pattern and has repository template. Generate Modules, Page
CLI package manager and template generator for Flutter. Generate Modules, Pages, Widgets, BLoCs and tests.
Why should I 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.
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:
- Activate the slidy using the pub:
flutter pub global activate slidy
slidy --versionto make sure everything is working properly. This command should return the installed version.
Updates slidy's version:
Create the basic structure of your project (make sure that your "lib" folder it's empty).
Runs the scripts in pubspec.yaml:
slidy run open_folder
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
Removes a package
slidy uninstall dio
You can also remove a dev_dependency using the flag --dev
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/
Common errors: #
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
- Go to
- Then click in New and add the path that appeared on your console.
If you have any doubt about setting up the system variables, watch this video.
For more details join our Telegram Group Flutterando