Languages: English (this file), 中文.
During my study of Flutter, I have been using the flutter_bloc state management framework. I accidentally saw the GetX state management framework. Through ReadMe, I found that the GetX framework is very easy to get started. So I want to write a GetX Starter project while learning, which can not only help myself Learning can also help others quickly build a boilerplate. Before building this boilerplate, I searched many similar projects, and found that they were relatively simple, and none of them covered the common things that the project should have, so I sprouted the idea of writing one by myself. Let me introduce them one by one below.
Technology & Project Introduction
Use Flutter 2.x to build a set of features containing predefined folder structure, style themes, API access, state management, routing & dependencies, etc. The project structure is clear and can be easily used as a Flutter template project. Technologies used include but are not limited to Flutter, Dart, GetX, etc.
Installation & Use
Fork this project to your own warehouse:
git clone https://github.com/KevinZhang19870314/flutter_getx_boilerplate.git
Open the project folder with VS Code and execute the following command to install the dependency package:
flutter pub get
Open the main.dart file in the lib folder, F5 or Ctrl + F5 to run the project, and then you can start developing and debugging.
The following is the project folder structure (only the folders under lib are introduced)
lib/ |- api - Global Restful api requests, including interceptors, etc. |- interceptors - Interceptors, including auth, request, and response interceptors. |- api.dart - Restful api export file. |- lang - Internationalization, including translation files, translation service files, etc. |- lang.dart - Language export file. |- models - Various structured entity classes, divided into request and response entities. |- models.dart - Entity class export file. |- modules - Business module folder. |- auth - Login & Registration Module. |- home - Home module. |- splash - Splash module. |- modules.dart - Module export file. |- routes - Routing module. |- app_pages.dart - Routing page configuration. |- app_routes.dart - Route names. |- routes.dart - Route export file. |- Shared - Global shared folders, including static variables, global services, utils, global Widgets, etc. |- shared.dart - Global shared export file. |- theme - Theme folder. |- app_bindings.dart - Services started before the app runs, such as Restful api. |- di.dart - Global dependency injection objects, such as SharedPreferences, etc. |- main.dart - Main entry.
In the writing process, because it involves the call of Restful api, here I used the free test api provided by REQ|RES.
Test User as below:
email: "firstname.lastname@example.org", password: "pistol"