Once you have forked the project, follow these steps :
- Run
flutter cleanonce as soon as you fork the project - Run
flutter pub get - Open Xcode and select the proper team and signing key
- Run
pod install - Run the application via flutter run !
- Files and folders MUST be named using snake case (eg home_page.dart)
- Classes MUST be named using pascal case (eg HomePage)
- Reusability is the key and Duplication is the lock - always break down widgets into separate reusable components
- Always keep the page layout and page child components separate unless really necessary
- Always store secrets and other shared configuration separately
- Responsiveness (ie fitting into different screen size) is the highest priority of design, use MediaQuery.of(context).size instead of hard coding size or width value.
- Make Use of Sizer library to provide maximum
- Use Row() and Column() wherever possible for designing layout
- Keep classes with low number of lines break widget into separate small widget if the class is too long (this increases maintainability)
The app is based around MVC (Model View Controller) pattern using Getx library, most context sensitive operation such as routes, alerts are mostly converted to non context sensitive functions to easily call it from controllers. Here are general rules that should be followed :
- We dont want any state to be maintained inside view so avoid statefull widgets and let controller manage the state
- Use context free alternative of functions like route & alert so that it can be used inside controllers
- Always Getx.put() the controller only once and retrive using Getx.find() whenever it is required
- Model , View and controller should recide inside same page package (look at folder by feature principal)
- If multiple pages rely on some states use shared controllers for those state wherever possible
The folder structure we are following is a mix of folder by type and folder by feature with main focus on folder by feature for easy access to all the required components of the page .
General Folder structure inside lib :
- config: this folder contains all files related to global configuration (eg: cooler palette, client secrets etc)
- pages: this folder contains the main logic divided into separate page folders, more on this later
- shared: this folder contains widgets that are used by multiple pages (eg: shell, back button)
- app.dart : the main app configuration , generally just creates a material app instance
- main.dat: acts as our entry point
Pages folder is divided into pages of screen , each page have at least these two property:
- A layout file , that is used to render the page
- A widgets folder , contains widgets that are needed to be render into layout divided by logical sense
- A controller file, that should contain all logical part, avoid using statefull widgets , let controller take care of state
By using folder by feature principal we make sure that all components required by the feature lie in the same folder or package. So anything related to a page must be inside the folder of that page which include any model, controller, extra custom package required by that page. This makes it easier for the developer to find everything he needs inside a single package or folder when he is working on a feature or page .
The widgets needs to be decoupled please do not pass the widget state around use broadcast libraryy to brodcast events between widgets for changing state rather than relying on global key or other workaroud. Always keep states inside controller and pass controllers singleton using Getx.find() makes it easier to decouple the application yet easily pass state around