Flutter Project

Covid app with an awesome UI

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

My goal with this project was to combine everything I have learned to build a fully functional, realistic and scalable Flutter app.

(back to top)

Built With

Frameworks, libraries and dependencies for this project

• Flutter (Main framework used)
• Freezed (Data modelling library)
• Autoroute (Navigation library)
• fl_chart (Chart library)
• flutter_bloc (Main state management library)
• flutter_svg (Rendering svg pictures)
• get_it (Service lovator for dependency injection )
• injectable (Dependency injection library)
• salomon_bottom_bar (Bottom navigation bar library)

(back to top)

Getting Started

Instructions on how to build the app

Prerequisites

• setup Android

• Dart

• Flutter

Installation

How to install the app.

1. Clone the repo

   git clone https://github.com/your_username_/Project-Name.git

2. Install Flutter dependencies (Pre-installed in pubspec.yaml)

   flutter pub get

3. Generate dpendency class

   flutter pub run build_runner build --delete-conflicting-outputs

(back to top)

Usage

Project can be used as a reference for building scalable apps and real-world apps. App features:

• Retrieves data from an API
• Null-safety
• Proper implementation of dependency injection
• Domain-Driven-Design Architecture
• Flutter Bloc State management
• Data Transfer Objects
• Navigation and routing

(back to top)

Roadmap

• Project structure setup
• Infrastructure layer (API)
• Domain layer (Models and reposiory facade)
• Application layer (Implement state management (Bloc))
• Presentation layer (setup UI)
• Link application layer to domain
• Render dynamic chart content
• Documentation
• Multi-language Support
  • Chinese
  • Spanish

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/ferdinandmwal123/flutter_proj

(back to top)

Acknowledgments

Resources used to develop this project

• Flutter Bloc Tutorial for Beginner (Video)
• Flutter Firebase & DDD (Video)
• Flutter Native Splash (Video)
• Dartz Using Either (Article)
• Using freezed with Bloc (Article)
• Flutter - bloc with freezed (Article)
• Flutter Bloc (v8.0.1) Pattern to load API data with Freezed and AutoRoute (Article)
• React Icons
• API used
• Networking in Flutter using Dio (Article)
• Data Modeling with Flutter using freezed package (Article)
• News app (Repository)
• Shields IO

(back to top)