Giter Club home page Giter Club logo

flutter_boilerplate_app's Introduction

Flutter boilerplate app

This is a boilerplate project for Flutter that provides a starting point for building a new application. It includes a basic project structure, common dependencies, and some sample code to help you get started.

Getting Started

To use this boilerplate, simply clone the repository and run flutter pub get to install the dependencies:

git clone https://github.com/MahanRahmati/flutter_boilerplate_app.git
cd flutter_boilerplate_app
flutter pub get

You can then open the project in your favorite IDE or text editor and start building your application.

Dependencies

This boilerplate includes several common dependencies that you may find useful when building your application:

Packages Description
riverpod State Manager
go_router Routing
go_router_builder Routing
hive Storage
intl Internationalization and Localization
arna_logger Logger
flutter_svg Draw SVG files
cached_network_image Load and cache network images
freezed Code generation for models
json_serializable Code generation for converting to and from JSON
flutter_native_splash Native splash screen
arna_web_service Web service
slang Internationalization and Localization
derry Script manager

You can add or remove dependencies as needed for your specific use case.

Project Structure

The project structure is organized into several directories:

lib: Contains the main part of source code for your application.
packages: Contains everything else that your application needs.

Special

gitignore

Remove the following lines from .gitignore:

/android/
/ios/
/linux/
/macos/
/web/
/windows/
.metadata

Models

To generate model files, execute the following command: derry models

Native Splash

To create native splash screen, execute the following command: derry native_splash

Localization

To generate localization files, execute the following command: derry slang

Providers

To generate provider files, execute the following command: derry providers

Router

To generate router files, execute the following command: derry router

License

This boilerplate is BSD 3-Clause licensed.

Contributing

Contributions are welcome! If you find a bug or want to add a new feature, please open an issue or submit a pull request.

TODO

Documentation:

  • app_apis
  • app_constants
  • app_localizations
  • app_models
  • app_widgets
  • screen_home
  • service_storage

flutter_boilerplate_app's People

Contributors

mahanrahmati avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.