Address Finder App

A Flutter application that allows users to input a Brazilian CEP (Código de Endereçamento Postal) code and retrieve the corresponding address information.

Table of Contents

• Features
• Installation
• Getting Started
• Built With
• Contributing
• License

Features

• Users can easily input any valid Brazilian CEP code
• The app fetches and displays the complete address, including street name, neighborhood, city, state, and postal code
• Provides informative error messages for invalid CEP codes

Installation

You need to install the Flutter SDK and configure the Android toolchain development first and then, in order to clone the project via HTTPS, run this command:

git clone https://github.com/jaquedreyer/address-finder-app.git

SSH URLs provide access to a Git repository via SSH, a secure protocol. If you have a SSH key registered in your Github account, clone the project using this command:

git clone [email protected]:jaquedreyer/address-finder-app.git

Install dependencies

flutter pub get

Getting Started

Run the following command in order to start the application in a development environment:

flutter run

Built With

• Core
  • Flutter - An open source framework by Google for building multi-platform applications
  • Dart - The programming language
• Packages
  • bloc - State management approach
  • http - For making HTTP requests
• API
  • ViaCEP - A reliable API for fetching address data based on CEP codes
• Project Structure
  • Clean Arch - Separate the different components of an application, creating modular, testable, and maintainable code

Contributing

I welcome contributions and suggestions from the community! If you come across any issues, have ideas for improvements, or wish to contribute in any way, feel free to open an issue or submit a pull request. I would love to learn with you!

License

Released in 2024. This project is licensed under the MIT License.

Made with love by Jaque Dreyer 🧡