Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ruishanteo committed Oct 10, 2023
1 parent 57b3591 commit b80ad39
Show file tree
Hide file tree
Showing 4 changed files with 73 additions and 0 deletions.
73 changes: 73 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Lefty

This app is designed to help you find the recipes by scanning the ingredients you have in order to reduce food waste.

<img src="docs/homePage.png" width="200" alt="Home Page">

## Features

- **Ingredient Scanning:** Easily add ingredients by scanning them with your device's camera.

<img src="docs/ingredientScanner.png" width="200" alt="Scan ingredient">

- **Ingredient Management:** Customise your ingredients list by manually adding or deleting ingredients.

<img src="docs/ingredientManagement.png" width="200" alt="Ingredient Management">

- **Recipe Search:** Search for mouth-watering recipes that match your ingredients.

<img src="docs/recipeList.png" width="200" alt="Recipe Search">

- **Detailed Recipe View:** View more information about each recipe, including the description, list of required ingredients, and even a step-by-step cooking instructions.

<img src="docs/detailedRecipe.png" width="200" alt="Detailed Recipe View">

- **Filter and Sort:** You can filter and sort to narrow down your recipe choices by dish type, cuisine, dietary preferences, and more.

<img src="docs/sortAndFilter.png" width="200" alt="Sort and Filter">

## Installation (for frontend)

1. Clone the repository to your local machine:

```bash
git clone https://github.com/ruishanteo/lefty.git
```

2. Navigate to the project directory:

```bash
cd lefty
```

3. Install dependencies using your preferred package manager:

```bash
npm install
# or
yarn install
```

4. Run the app on a connected device or emulator:

```bash
npm start
# or
yarn start
```

5. Follow the on-screen instructions to launch the app.

## Technologies used

<p>

<img align="left" alt="React Native" width="26px" src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/react/react-original.svg" style="padding-right:10px;" />
<img align="left" alt="JavaScript" width="26px" src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/javascript/javascript-original.svg" style="padding-right:10px;" />
<img align="left" alt="Python" width="26px" src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/python/python-original.svg" style="padding-right:10px;" />
<img align="left" alt="Google Vision AI" width="26px" src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/googlecloud/googlecloud-original.svg" style="padding-right:10px;" />
<img align="left" alt="Git" width="26px" src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/git/git-original.svg" style="padding-right:10px;" />

&nbsp;

</p>
Binary file added docs/ingredientScanner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/recipeList.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/sortAndFilter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b80ad39

Please sign in to comment.