chelseaharris137/GoodGrub

Recipe finder

About The Project

GoodGrub features a wide variety of recipes, from classic comfort foods to international dishes and healthy options. We make it easy to find the perfect recipe for any occasion, with options sorted by cuisine, ingredients, and dietary restrictions.

We believe that cooking should be fun, easy, and accessible to everyone, which is why we're dedicated to providing the best recipe app on the market. So why wait? Download GoodGrub now and start cooking up a storm!

(back to top)

Built With

• 
• 
• 
• 
• 

(back to top)

Getting Started

Installation

1. Clone the repo:

   git clone https://github.com/chelseaharris137/GoodGrub.git

2. Install packages:

   yarn install

3. Run the development server:

   yarn dev

(back to top)

Linter

GoodGrub uses ESlint and Prettier to identify problematic patterns and clean up code.

1. To run the linters:

   yarn lint

2. To fix linting errors:

   yarn lint --fix

(back to top)

Testing

GoodGrub uses Jest and React Testing Library for testing purposes. Existing unit and snapshot tests can be found in src under the __tests__ folder.

1. To run tests:

   yarn test

2. Update snapshots:

   yarn test -u

(back to top)

Contributing

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

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 for more information.

(back to top)

Acknowledgements

Big thanks to TheMealDB for providing a free API that communicates with an awesome crowd-sourced database of Recipes from around the world!

(back to top)