CookAlong

Master the art of cooking with your hands-free, digital sous chef who guides you through recipes by voice command.

View Demo and Presentation

Table of Contents

1. About The Project
   • Built With
   • Features
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. Contact
6. Acknowledgements

About The Project

Built With

• ReactJS
• Bulma
• Ruby On Rails
• Spoonacular API
• Web Speech API

Features

• Search and choose a recipe
• Randomize search results
• Preview a recipe before beginning
• Read out each step of a recipe
• Respond to the voice commands "next", "previous", and "repeat"

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/acm-projects/CookAlong

2. Install NPM packages

   npm install

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

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

Contact

Project Manager:

• Emily Lam - LinkedIn -

Industry Mentor:

• Alex Dometrius - LinkedIn -

Participants:

• Patrick Drury - LinkedIn -
• Ryan Dimaranan - LinkedIn - rtd180003@utdallas.edu
• Hannah Valena - LinkedIn - hannah.valena@utdallas.edu
• Nam Truong - LinkedIn -

Project Link: https://github.com/acm-projects/CookAlong

Acknowledgements

• ACM UTD