ingredient_collector - 0.7.0

An app that collects ingredients from recipe websites and combines them into a shopping list.

Test it out »

Report Bug Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
   • Adding support for a recipe website
6. Releasing
7. License

About The Project

ingredient_collector uses HTTP requests to collect the ingredients of a recipe website and combines them into a shopping list.

Built with

• 

(back to top)

Getting Started

Prerequisites

1. Install flutter

2. Run flutter doctor -v

3. Make sure there is no category with an error.

Installation

1. Clone the repo

   git clone https://github.com/Slartibartfass2/ingredient_collector.git
   cd ingredient_collector

2. Run setup file

   On Windows run:

   .\setup.ps1

   On Linux/macOS run:

   bash setup.ps1

3. Run it on your preferred device

   flutter run -d <device-id>

   You can list all available devices using

   flutter devices

4. Run the following commands to build the release version

   • For the Web release run:

     flutter build web --base-href="/ingredient_collector/"

     More information on releasing for Web

   • For the Windows release run:

     flutter build windows

     More information on releasing for Windows

   • For the Android release run:

     flutter build apk

     More information on releasing for Android

(back to top)

Usage

1. Enter recipe information.

2. Submit your request.

3. Results are listed in the text area.

4. Now you can copy the ingredients to your note app e.g. Google Keep.

(back to top)

Roadmap

• Add support for KptnCook
• Add support for Eat This
• Add support for Bianca Zapatka
• Add support for Chefkoch
• Add support for Nora Cooks
• Add support for BBC Good Food

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 feat/AmazingFeature)
3. Commit your Changes (git commit -m 'feat: Add some AmazingFeature')
4. Push to the Branch (git push origin feat/AmazingFeature)
5. Open a Pull Request

Adding support for a recipe website

1. Add a new parser in ./lib/src/recipe_parser/ extending RecipeParser as part of recipe_parser.

   part of 'recipe_parser.dart';
   
   class ExampleParser extends RecipeParser {
     const ExampleParser();
   
     @override
     RecipeParsingResult parseRecipe(
       Document document,
       RecipeParsingJob recipeParsingJob,
     ) {
       ...
     }
   }

2. Declare the new parser in ./lib/src/recipe_parser/recipe_parser.dart

   library recipe_parser;
   
   part 'example_parser.dart';
   
   ...

3. Add the new supported website in ./lib/src/recipe_controller/recipe_website.dart.

   exampleWebsite("https://www.example.org", ExampleParser());

4. Add tests in ./test/recipe_parser_tests/ to ensure the parsing works.

(back to top)

Releasing

1. Change version in pubspec.yaml
2. Change version in README.md
3. Add changelog entry in CHANGELOG.md

License

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

(back to top)