Git Product home page Git Product logo

-gourmet-guidebook--project's Introduction

Project Pitch:

Owner/s: [Melissa Velasquez Greene]

Phase and Cohort: Flask Phase 5 SE111323

App description:Gourmet Guidebook is a web application designed to help users manage their recipes.

CRUD User Story

As a user, I want to be able to create, read, update, and delete recipes of my planned and actual time, as well as categorize recipes and rate them.

Domain Model

domain model In this repo:

  • There is a Flask application with some features built out.
  • There is a fully built React frontend application.

You can check your API by:

  • Using Postman to make requests

  • Running the React application in the browser and interacting with the API via the frontend

You can import project-5-Movie-City.postman_collection.json into Postman by pressing the Import button.

Installation Instructions

To download the dependencies for the frontend and backend, run:

pipenv install
pipenv shell
npm install --prefix client

You can run your Flask API on 127.0.0.1:5000 by running:

python server/app.py

running:

npm start --prefix client
export FLASK_APP=server/app.py
flask db init
flask db upgrade head

You can run your Flask API on localhost:5555 by running:

python server/app.py

You can run your React app on localhost:4000 by running:

npm start --prefix client

Domain Model

  • Models:
    • Many-to-many relationship
    • A recipe belongs to one or more categories
    • A category has many recipes
    • A recipe can have ratings
    • A user can rate multiple recipes
    • A recipe has ingredients and instructions
    • A user has many recipes

Validations

  • Add validations to the Recipe model:
    • Must have a title, ingredients, instructions, and category_id
  • Add validations to the Category model:
    • Must have a name
  • Add validations to the Rating model:
    • Must have a user_id, recipe_id, and rating value
  • Add validations to the User model:
    • Must have a username, email, and password

API Routes

- Recipe:
- GET /recipes/
 - POST /recipes/
 - GET /recipes/<int:id>
 - PATCH /recipes/<int:id>
 - DELETE /recipes/<int:id>
- Category:
  - GET /categories/
  - POST /categories/
  - GET /categories/<int:id>
  - PATCH /categories/<int:id>
  - DELETE /categories/<int:id>
- Rating:
  - GET /ratings/
  - POST /ratings/
  - GET /ratings/<int:id>
  - PATCH /ratings/<int:id>
  - DELETE /ratings/<int:id>
- User:
  - GET /users/
  - POST /users/
  - GET /users/<int:id>
  - PATCH /users/<int:id>
  - DELETE /users/<int:id>

Frontend (React)

Component Hierarchy

  • App Component
    • Header Component
    • Main Component
      • RecipeList Component
      • RecipeDetail Component
      • RecipeForm Component
      • CategoryList Component
      • CategoryForm Component
      • RatingForm Component
      • UserList Component
      • UserForm Component
    • Footer Component

Component Details

  • React Routes:
    • /: Home page displaying a list of recipes
    • /recipes/:id: View details of a specific recipe
    • /recipes/new: Create a new recipe
    • /recipes/edit/:id: Edit an existing recipe
    • /categories/: View all categories
    • /categories/new: Create a new category
    • /categories/edit/:id: Edit an existing category
    • /users/: View all users
    • /users/new: Create a new user
    • /users/edit/:id: Edit an existing user

Contributing

Contributions are welcome! If you have any suggestions, bug fixes, or feature implementations, please open an issue or create a pull request.

License

This project is licensed under the MIT License.

-gourmet-guidebook--project's People

Contributors

melissa0191 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.