🚫 Note: All lines that start with 🚫 are instructions and should be deleted before this is posted to your portfolio. This is intended to be a guideline, feel free to add your own flare to it.

🚫 The numbers 1️⃣ through 5️⃣ next to each item represent the week that part of the docs needs to be comepleted by. Make sure to delete the numbers by the end of Labs.

🚫 Each student has a required minimum number of meaningful PRs each week per the rubric. Contributing to docs does NOT count as a PR to meet your weekly requirements.

You can find the deployed project at WORK IN PROGRESS(REACT-NATIVE) [🚫URL NAME GOES HERE](🚫copy and paste URL here).

Amir	Kenya	Hannah	Obaida	[Heymi UX]

more info on using badges here, [make your own] (https://shields.io/#your-badge)

Trello Board

Product Canvas

UX Design files

RecipeShare is the best place to collaborate with other cooks to create the best possible recipes. A cooking community for sharing recipes and alterations.

v1.0

• GET all recipes to show up in a list of cards
• SEARCH functionality for recipes
• LOGIN/LOGOUT authentication
• POST a detailed recipe once logged in

• "dependencies"
• "@react-native-community/async-storage": "^1.6.2",
• "axios": "^0.19.0",
• "react": "16.9.0",
• "react-native": "0.61.2",
• "react-native-gesture-handler": "^1.4.1",
• "react-native-reanimated": "^1.3.0",
• "react-native-screens": "^2.0.0-alpha.5",
• "react-navigation": "^4.0.10",
• "react-navigation-stack": "^1.10.2",
• "react-navigation-tabs": "^2.5.6",
• "react-native-elements": "^1.2.6",
• "react-native-modal-dropdown": "^0.7.0",
• "react-native-vector-icons": "^6.6.0",
• "styled-components": "^4.4.0",
• "toggle-switch-react-native": "^2.1.0"
• "devDependencies"
• "@babel/core": "^7.6.4",
• "@babel/runtime": "^7.6.3",
• "@react-native-community/eslint-config": "^0.0.5",
• "babel-jest": "^24.9.0",
• "eslint": "^6.5.1",
• "jest": "^24.9.0",
• "metro-react-native-babel-preset": "^0.56.0",
• "react-test-renderer": "16.9.0"

Why did you choose this framework?

• Mobile first
• Ability to use for iOS and Android
• Mobile is the popular choice while cooking/looking for ingredients on the go

• "devDependencies":
• "cross-env": "^6.0.3",
• "jest": "^24.9.0",
• "nodemon": "^1.19.4",
• "supertest": "^4.0.2"
• "dependencies":
• "bcryptjs": "^2.4.3",
• "cors": "^2.8.5",
• "dotenv": "^8.2.0",
• "express": "^4.17.1",
• "jest": "^24.9.0",
• "jsonwebtoken": "^8.5.1",
• "knex": "^0.19.5",
• "pg": "^7.12.1",
• "psql": "0.0.1",
• "supertest": "^4.0.2"

Axios/Auth/JWT, built from scratch

n/a

n/a

In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following:

🚫These are just examples, replace them with the specifics for your app

*  REACT_APP_apiKey - this is your Google API key, which can be generated in the Google Cloud Console
*  REACT_APP_authDomain - when you set up your Firebase project, this information will be in the dashboard
*  REACT_APP_databaseURL - in the Firebase dashboard
*  REACT_APP_projectID - in the Firebase dashboard
*  REACT_APP_storageBucket - in the Firebase dashboard
*  REACT_APP_messagingSenderId - in the Firebase dashboard
*  REACT_APP_stripe_API - this is your public Stripe API key, generated in the Stripe dashboard
*  REACT_APP_backendURL - optional for your local development server
*  REACT_APP_clientid - this is the Stripe_connect clientID, generated in Stripe_connect settings
*  REACT_APP_stripe_plan - this is the ID for a second Stripe subscription plan, generated under Stripe products

• https://www.figma.com/file/yckNzpK8dwMjsWrMNkdl3i/Material-Icons-(Outlined)-(Copy)?node-id=0%3A22
• https://www.figma.com/resources/assets/material-icons-outline/
• https://unsplash.com/s/photos/food

• Jest: Standard for Javascript
• React-Native-Testing-Library:compatible with react-native

🚫explain how to install the required dependencies to get this project up and running with yarn and NPM

• "android": "react-native run-android",
• "ios": "react-native run-ios",
• "start": "react-native start",
• "test": "jest",
• "lint": "eslint ."

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.

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.

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.

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.

• 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.

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

See Backend Documentation for details on the backend of our project.