Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
revforev authored Nov 10, 2023
1 parent 0534b1f commit f081e57
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,30 @@ Zest is a web app that lets users find and sort recipes.

## Project Description

Zest is a web app that lets users find and sort recipes. It uses the Tasty API. By default users can see browse an entire page of recipes. Users can search for recipes by their name (such as mac and cheese) and category (such as vegetarian, or pasta). Moreover, the user can filter recipes by categories.
Zest is a web app that lets users find and sort recipes. It uses the Tasty API and features a modern design which is light, fully responsive and accessible. By default users can see browse an entire page of recipes. Users can search for recipes by their name (such as *mac and cheese*) and ingredient (such as *cheese*).

## Major Functions and Features

1. **Browse recipes:** The landing page features a list of recipe cards, which contain information about ingredients, cooking times and step-by-step directions. Each of the recipes contains a picture of the dish and a nutritional chart. The recipes displayed are fetched using the Tasty API.

2. **Find recipes:** By interacting with the search bar, the user can look for recipes entering a dish name or a category description (such as "under 30 minutes"). The results show up on the main page when the user use the search bar.

2. **Sort recipes:** The user can sort the recipes by cooking time, nutritional value and alphabetically.
3. **Responsive design:** The website is made fully responsive on all viewports using flex and media queries, and it features cards in a layout of 5 to 1 columns.

4. **Dark mode:** There is an integrated dark mode for accessibility, which can be switched to using a toggle on the top right corner of the website. The website colors pass the AAA test on the Web Accessibility Guidelines, and they are both legible and easy on the eyes.

---

## Dependencies

To run "Zest" you will need the following dependencies and libraries:

- axios - Version 1.5.0
- chart.js - Version 4.3.3
- react - Version 18.2.0
- [React](https://react.dev/learn)
- [React Router](https://reactrouter.com/en/main)
- [Redux Store](https://redux.js.org/api/store)
- [Axios](https://axios-http.com/docs/intro)
- [Vite](https://vitejs.dev/guide/)
- [Tasty API](https://rapidapi.com/apidojo/api/tasty)

## Project setup

Expand Down

0 comments on commit f081e57

Please sign in to comment.