This is the documentation of Flutter Applications. It holds all the info you need to get started with and make changes to your App. I made it as a study projectas i was getting ready for my recess project.
- System Requirements
- Figma design guideline for better accuracy
- App Navigations
- Project Structure
- How you can do code formatting?
- How you can improve the readability of code?
- Libraries and tools used
- Support
Dart SDK Version 2.17.0 or greater. Flutter SDK Version 3.0.0 or greater.
Read our guidelines to increase the accuracy of design conversion to code by optimizing Figma designs. https://docs.dhiwise.com/docs/Designguidelines/intro
Check your app's UI from the AppNavigation screen of your app.
After successful build, your application structure should look like this:
.
โโโ android - contains files and folders required for running the application on an Android operating system.
โโโ assets - contains all images and fonts of your application.
โโโ ios - contains files required by the application to run the dart code on iOS platforms.
โโโ lib - Most important folder in the project, used to write most of the dart code.
โโโ main.dart - starting point of the application
โโโ core
โ โโโ app_export.dart - contains commonly used file imports
โ โโโ constants - contains all constants classes
โ โโโ errors - contains error handling classes
โ โโโ network - contains network related classes
โ โโโ utils - contains common files and utilities of project
โโโ data
โ โโโ apiClient - contains api calling methods
โ โโโ models - contains request/response models
โ โโโ repository - network repository
โโโ localization - contains localization classes
โโโ presentation - contains all screens and screen controllers
โ โโโ screens - contains all screens
โโโ routes - contains all the routes of application
โโโ theme - contains app theme and decoration classes
- if your code is not formatted then run following command in your terminal to format code
dart format .
Resolve the errors and warnings that are shown in the application.
- get - State management https://pub.dev/packages/get
- connectivity_plus - For status of network connectivity https://pub.dev/packages/connectivity_plus
- pull_to_refresh - For list functionalities https://pub.dev/packages/pull_to_refresh
- cupertino_icons - For iOS icons https://pub.dev/packages/cupertino_icons
- shared_preferences - Provide persistent storage for simple data https://pub.dev/packages/shared_preferences
- cached_network_image - For storing internet image into cache https://pub.dev/packages/cached_network_image
If you have problems or questions go to our Discord channel, we will then try to help you as quickly as possible: https://discord.com/invite/rFMnCG5MZ7