MyDish App

🍽 A source-control cooking app built in React Native which allows users to quickly make and see changes to their recipe. ​ You can find the deployed project on the Google Play Store for Android devices or via TestFlight for iOS devices. ​ TestFlight Instructions ​

• Search for TestFlight in the App Store.
• Once installed, follow this link. ​

Table of Contents

• Getting Started
• Contributors
• Project Overview
• Tech Stack
• APIs
• Contributing ​

Getting Started

1. Set up React Native. Choose tab Expo CLI Quickstart.
2. Fork or directly clone this repository to your local machine and cd into the project directory.
3. Run npm install and once that is complete expo start.
4. If you want to test on a simulator, you may use either Android Studio for Android or XCode for iOS.
5. Run a for Android simulator or i for iOS simulator.
6. If you want to test on an actual device, first make sure you have installed the expo app. Then, use the barcode provided in your terminal or in the browser after running expo start.
7. To run tests in tests directory run this command in the root of this repo: npm test ​

Contributors

Katie Embrey-Farquhar	Dan Hauer	Tanner Hawkins	Indigo Richards	Winnie Song

​ ​

Olympia Wojcik	James Bishop	Devin Warrick	Dustin Snoap

​

​ ​

Project Overview

​ Trello Board ​ Product Canvas ​ UX Design files ​ MyDish allows users to create their own recipes and keep track of different versions of those recipes as they change them over time. Users can also explore recipes created by others. ​

Key Features

• Recipe creation
• Editing a recipe
• Version History
• Image upload ​

Tech Stack

Front End	Back End	Testing
React Native	NodeJS	Jest
React Navigation	ExpressJS	React Test Renderer
Redux	Knex.js
React-Redux	Amazon S3

​

APIs

MyDish API

​ The MyDish API is used throughout this React Native front-end to do things such as creating an account, logging in, creating recipes, viewing recipes, editing recipes, etc. ​ Documentation on how to use the MyDish API can be found here. ​

Ingredient Prediction API

​ This API is a data science ingredient prediction model. Based on the request, it will respond with a list of suggested ingredients. It accepts a POST request formatted as such: ​

{
    "1": "garlic",
    "2": "butter",
    "3": "chives"
}

​ Further documentation on how to use this API can be found here. ​ The GitHub Repository can be found here. ​

Contributing

​ When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. ​ Please note we have a code of conduct. Please follow it in all your interactions with the project. ​

Issue/Bug Request

​ If you are having an issue with the existing project code, please submit a bug report under the following guidelines: ​

• Check first to see if your issue has already been reported.
• Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
• Create a live example of the problem.
• Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered. ​

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented. ​

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project. ​ Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too. ​

Pull Request Guidelines

• Ensure any install or build dependencies are removed before the end of the layer when doing a build.
• Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
• Ensure that your code conforms to our existing code conventions and test coverage.
• Include the relevant issue number, if applicable.
• You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.