RESTful Recipes

Description

RESTful Recipes is a web application for bootcamp students (or anyone really) to share cooking recipes! Users can view and search for recipes. After signing up users can add and remove recipes from the online database. Let's try each other's favourite foods!

Table of Contents

• Installation

• Usage

• License

• Contributing

• Test

• Questions

  Installation

  You can access the app online by visiting RESTful Recipes.

  Usage

  It is a very simple website interface. The homepage will display a random recipe. Users can enter words(tags) into the "What are you craving?" field, and click "Start cooking!" The website will search the database for any recipes that include the tags and display them. If there are no matches the website will let the user know. Click on the name of a recipe to visit it's specific page with more information such as ingredients and instructions. Visit the "Login" page from the navbar to either log into an existing account or signup for a new account. Account passwords are encrypted! Once logged in users have accesse to their profile page to create and delete recipes. All of a users recipes are visible from their profile page. If a user wants to delete their account this can also be done from the profile page. Any corresponding recipes will also be deleted.

  Video Demo

  Screenshots

  

  License

  This project is licensed under the MIT License.

  Contributing

  We welcome contributions to RESTful Recipes! To get started:

  1. Fork the repository.
  2. Create a new feature branch.
  3. Make changes, commenting your code and using descriptive commits.
  4. Create a pull request with clear comments.

  Test

  To test the app:

• Search for recipes using keywords.

• Create an account and try creating, deleting, and searching for recipes.

  Questions

  For more information, feel free to reach out to our project maintainers:

• GitHub: SarahNk1-Maker

• GitHub: alexandrazykova

• GitHub: BenACooper