Skip to content

Base project according to our files and code structure with BLoC state management approach

Notifications You must be signed in to change notification settings

Musaddiq625Org/base_project

Repository files navigation

Base Project - BLoC Pattern

Inital flutter project with pre-define packages and BLoC pattern approach.

Packages:

  1. cupertino_icons: ^1.0.2
  2. flutter_bloc: ^8.0.1
  3. dio: ^4.0.6
  4. image_picker: ^0.8.5+3
  5. photo_view: ^0.14.0
  6. image_cropper: ^3.0.0
  7. shared_preferences: ^2.0.15
  8. intl: ^0.17.0
  9. get_it: ^7.2.0 10.fluttertoast: ^8.0.9
  10. flutter_svg: ^1.1.3
  11. flutter_local_notifications: ^9.7.0
  12. cached_network_image: ^3.2.1
  13. google_fonts: ^3.0.1
  14. device_info_plus: ^4.1.0
  15. connectivity_plus: ^2.3.6+1
  16. flutter_image_compress: ^1.1.1
  17. flutter_lints: ^2.0.0
  18. flutter_launcher_icons: ^0.10.0
  19. change_app_package_name: ^1.1.0
  20. flutter_localizations: sdk: flutter

Contributors

  1. Musaddiq Ahmed Khan Musaddiq625 | LinkedIn
  2. Adil Ahmed AdilAhmed | LinkedIn
  3. Ammar Ayoubi AmmarAyoubi | LinkedIn

Getting Started 🚀

There are two ways:

  1. Clone
  2. Installation (Recommended)

Clone

Clone the the base_project repository

 git clone https://github.com/Musaddiq625Org/base_project.git

Installation

Ensure you have the use_template installed.

🎯 Activate from https://pub.dev

dart pub global activate use_template

Write following command in your prefer terminal

use_template

You are asked for three parameters.

  1. New name: This will be the new name of your application.
  2. Template: Paste the following Git URL.
https://github.com/Musaddiq625Org/base_project.git
  1. Directory to install template: Your system absolute local path where you want to save project or you can leave it empty to install it on the current directory.

Output Directory Structure 📦

Generated folder architecture

📂android
📂assets
 ┣ 📂app_icon
 ┃ ┗ 📜sample_icon.png 
 ┣ 📂images
 ┃ ┗ 📜sample_image.png  
 ┣ 📂vector
 ┃ ┗ 📜sample_vector.svg   
📂ios
📂lib
 ┣ 📂components
 ┃ ┣ 📂media
 ┃ ┃ ┗ 📜custom_image_preview.dart
 ┃ ┃ ┗ 📜media_source_selection_widget.dart 
 ┃ ┣ 📜loading_dialog.dart
 ┃ ┣ 📜main_scaffold_component.dart 
 ┃ ┣ 📜text_component.dart
 ┃ ┣ 📜toast_component.dart  
 ┣ 📂src
 ┃ ┣ 📂app_cubit
 ┃ ┃ ┗ 📜app_cubit.dart
 ┃ ┃ ┗ 📜app_state.dart 
 ┃ ┣ 📂constants
 ┃ ┣ ┣ 📂language_constant
 ┃ ┃ ┃ ┗ 📜english.dart
 ┃ ┃ ┃ ┗ 📜urdu.dart
 ┃ ┣ ┣ 📜app_constants.dart 
 ┃ ┣ ┣ 📜asset_constants.dart
 ┃ ┣ ┣ 📜color_constants.dart 
 ┃ ┣ ┣ 📜date_constants.dart 
 ┃ ┣ ┣ 📜font_styles_constants.dart 
 ┃ ┣ ┣ 📜http_constants.dart 
 ┃ ┣ ┣ 📜padding_constants.dart 
 ┃ ┣ ┣ 📜route_constants.dart 
 ┃ ┣ ┣ 📜shared_preference_constants.dart 
 ┃ ┣ ┣ 📜sizedbox_constants.dart 
 ┃ ┣ ┣ 📜string_constants.dart 
 ┃ ┣ 📂enums
 ┃ ┃ ┗ 📜sample_enum.dart
 ┃ ┣ 📂models
 ┃ ┃ ┗ 📜sample_model.dart 
 ┃ ┣ 📂repositories
 ┃ ┃ ┗ 📜token_repository.dart
 ┃ ┣ 📂screens
 ┃ ┣ ┣ 📂splash
 ┃ ┃ ┣ ┣ 📂cubit
 ┃ ┃ ┃ ┃ ┗ 📜splashe_cubit.dart
 ┃ ┃ ┃ ┃ ┗ 📜splash_state.dart
 ┃ ┃ ┃ ┗ 📜splash_interface.dart
 ┃ ┃ ┃ ┗ 📜splash_screen.dart
 ┃ ┣ 📂screens_args
 ┃ ┃ ┗ 📜sample_screen_args.dart 
 ┃ ┣ 📂services
 ┃ ┃ ┗ 📜navigation_service.dart
 ┃ ┃ ┗ 📜translation_srevice.dart
 ┃ ┃ ┗ 📜validation_service.dart
 ┃ ┣ 📂utils
 ┃ ┣ ┣ 📂firebase
 ┃ ┃ ┣ ┣ 📂firebase_wrappers
 ┃ ┃ ┃ ┃ ┗ 📜android_response_wrapper.dart
 ┃ ┃ ┃ ┃ ┗ 📜ios_response_wrapper.dart
 ┃ ┃ ┃ ┗ 📜firebase_util.dart
 ┃ ┣ ┣ 📜connection_util.dart
 ┃ ┣ ┣ 📜date_util.dart
 ┃ ┣ ┣ 📜datetime_picker.dart 
 ┃ ┣ ┣ 📜device_util.dart 
 ┃ ┣ ┣ 📜launcher_util.dart 
 ┃ ┣ ┣ 📜logger_util.dart 
 ┃ ┣ ┣ 📜navigation_util.dart 
 ┃ ┣ ┣ 📜share_util.dart 
 ┃ ┣ ┣ 📜shared_preferences_util.dart 
 ┃ ┣ 📂wrappers
 ┃ ┃ ┗ 📜token_res_wrapper.dart
 ┣ 📜generated_route.dart
 ┣ 📜main.dart
📂linux
📂macos
📂test
📂web
📂windows
📜.gitattributes
📜.gitignore
📜.metadata
📜analysis_options.yaml
📜pubspec.lock
📜pubspec.yaml
📜README.md

In this template we have some of our widgets which we are using in our live projects. Somehow this code is tested by the developers, if you find any issue or you can optimize it Feel free to contribute in this project

License 🍀

MIT License

Copyright (c) 2022 Musaddiq625Org

Permission is hereby granted, free of charge, to any person obtaining a copy 
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

About

Base project according to our files and code structure with BLoC state management approach

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published