Skip to content

Latest commit

 

History

History
90 lines (57 loc) · 1.96 KB

README.md

File metadata and controls

90 lines (57 loc) · 1.96 KB
Raw

RecipeApp

A basic recipe app for a technical assignment by yourbeet.

Key Features

  • Home Page: View a list of different recipes and a brief description.
  • Recipe Details Page: View the details of the recipe, including the full ingredients list and steps to make it.
  • Checkboxes: Check off boxes of each ingredient/step.
  • Timer: Manage a countdown timer to keep track of cooking process.

Requirements

  • React Native 0.63 or higher
  • Node.js 12 or higher
  • Yarn or npm installed
  • Expo CLI install
  • Android Studio(Windows) or Xcode(Mac) for running the mobile application on an emulator/simulator or a physical device

Quickstart

Follow these steps to get the project up and running on your local machine.

  1. Clone the repository
git clone https://github.com/c-wenlong/recipe-app-your-beet.git
cd recipe-app-your-beet
  1. Install dependencies

Using npm:

npm install

Or using Yarn:

yarn
  1. Start the server

Using node:

node index.js

Or using nodeon:

npm install nodemon
nodemon index.js

And in case it shows error that express cannot be found, run:

npm install express
  1. Start the Metro bundler

On a different terminal, run:

npx expo start
  1. Run the app

Scan the QR code on Expo Go, you can download it from the App/Play Store:

Ensure that you're devices are all connected to the same network for this to work!

Expo Go Instruction

Run the app on IOS Simulator using XCode on Mac and Android Studio on Windows:

Android Studio & IOS Instruction

Usage

Once you enter the app, you will see an automatically generated list of recipes, exactly 4 in total. These are the default recipes, but you can change it by changing the .json file at /assets/recipes.json.

You can view an individual recipe by clicking into it and use the checkbox and timer functions to keep track of progress while cooking.