Recipe Finder

Recipe Finder is a mobile application that allows users to search for recipes based on keywords and view recipe details. The app also allows users to add recipes to their favorites and stores their search history.

Modularization

Keywords

• DDD (Domain Driven Design)
• MVVM (Model-View-ViewModel architecture)
• DI (Dependency Injection) management
• Multi-Modularization: Development of application logic by dividing it into separate modules
• Local database management using SQFlite and Shared Preferences
• SOLID principles (as long as possible): Implementation of the Single Responsibility, Open-Closed, Liskov Substitution, Interface Segregation, and Dependency Inversion principles for improving code quality
• Flutter Navigation Management
• Base classes for managing state
• Unit tests (as long as possible): Implementation of unit tests for the business logic of the application

To-do

• Add a "Random Recipe" feature for users to find a recipe randomly.
• Filter search results by dietary requirements.
• Add a recipe-sharing feature.
• Add service error handling.

Features

• Recipe search: Users can search for recipes using keywords.
• Recipe details: Users can view details for any recipe by clicking on it.
• Add to favorites: Users can add recipes they like to their favorites.
• Search history: Users can view their previous searches and perform them again.

Architecture

• This project is designed using the MVVM (Model-View-ViewModel) architecture to separate data, business logic and user interface layers, making it more modular and maintainable.
• Domain-Driven Design (DDD) principles were applied to organize the business logic around business domains and clarify their relationships, making the application more scalable and maintainable.
• The application was developed using MVVM and DDD principles. MVVM helps maintain a balance between the functionality of the user interface layer and the independence of the data layer. DDD provides a framework for organizing the business logic, allowing for extensibility.
• The project is designed using the MVVM and DDD principles. MVVM separates the different layers of the application, making it easier to maintain, while DDD provides a structure for the business logic to be organized, making the application more scalable.
• MVVM and DDD principles were used to develop the application. MVVM provides a balance between the functionality of the user interface layer and the independence of the data layer, while DDD helps organize the business logic and allows for the application to be extended.

Used Packages

• dio: A powerful HTTP client for Dart, used for making HTTP requests.
• json_annotation: A package used for JSON serialization/deserialization in Dart.
• sqflite: A Flutter plugin for SQLite databases, used for local database storage.
• shared_preferences: A Flutter plugin for storing key-value pairs on disk, used for local data storage.
• provider: A Flutter package for state management, used for managing state with the Inherited Widget structure.
• gap: A package for adding padding and spacing between widgets.
• cached_network_image: A package for caching images from the network.
• get_it: A package used for dependency injection in Dart and Flutter.
• injectable: A package for generating code for dependency injection in Dart and Flutter.

Getting Started

To run the app, you can follow these steps:

1. Clone this repository.
2. Run flutter pub get to install dependencies.
3. Run flutter run to start the app.

Note: To run the application, you need to add the following parameters when running the flutter run command:

1. --dart-define="app_id=your_app_id"
2. --dart-define="app_key=your_app_key"

I used the following API for food recipes. Edamam Recipe API

Code Generation

This project uses code generation to reduce boilerplate code and improve development speed. The following tools are used:

• json_serializable: Used for JSON serialization/deserialization.
• build_runner: Used for running code generation tasks.

To generate the code, run the following command:

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

This will generate the necessary code for JSON serialization/deserialization. You should run this command every time you make changes to any files that use the @JsonSerializable annotation.

If you encounter any issues with code generation, try running the following command to clean up generated files before running build_runner:

flutter pub run build_runner clean

Contributing

Contributions are always welcome! If you find any bugs or want to suggest new features, feel free to open an issue or submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.