pinchef

Click? ‍?

BACKEND API RESTful for Pinchef

Why is it called Pinchef?

Well, a click on the bad tongues that means cooking assistant. And from the chef pabra that means "cook." Also that he has in his unique the pin that is like Guardalo. Similar to Pinterest.

What is Pinchef App?

A web application that allows you to select cooking recipes and generate a shopping list.

The idea is that selections that recipes want to cook in the week and generate a shopping list for the supermarket.

Example:

Select for one day of the week

• Monday:
  • breakfast:
    • Chilaquiles
    • coffee with milk
  • Meal:
    • Picadillo (ground meat with potatoes and carrots)
    • White rice with chicharos
    • Noodle soup
    • Lemon water
  • Dinner:
    • Comprehensive toast with cottage cheese, smoked salmon and tomato cherry
    • Chamomile

And so you generate a shopping list for the supermarket based on your selection.

The Pinchef App generates a shopping list for the supermarket helping you to organize the menu of the week. It would be cool that can be connected to the APIs of the stores to make the online shopping order.

If there are empty days in the week, will it notify you that you have to order or go buy? (taquitos) in the schedules or days of the week that you do not have selected the menu to cover holes and do not stay without feeding.

Show you recipes based on your tastes and your diet.

Recommendations to be Fit or Fat? If you notice that you make a lot of cream to your tacos?

Top for vegetarian and vegan diet?

Based on your purchases, you can suggest recipes that may interest you since no one goes to the market to buy 2 potatoes only for the mice for example, I would tell you if you have potatoes you can make these recipes with the potatoes such as potato pure for your accompaniment in meals.

Generate a menu for breakfast, food and dinner week based on a limited budget.

Install & Run

First we clone the repository either in the terminal or in the Code button.

git clone https://github.com/GeraAlcantara/pinchef.git
cd pinchef

Modify the .env configuration file

We have to rename the Modify_me.env a .env and modify the values ​​of the variables removing the {} .

Terminal

mv modify_me.env .env

Dockers

We must have Docker and Docker-Composate installed.

Terminal

sudo apt-get update
sudo apt-get install docker.io
sudo apt-get install docker-compose
sudo usermod -aG docker $USER 

Build

docker-compose build

Run

docker-compose up

Run the app without dockers

We must create a Virtual SUB and install the dependencies. We use VENV to create the Virtual Env.

The Sqlalchemy_database_url variable must be changed to a SQLite database.

SQLALCHEMY_DATABASE_URL= sqlite:///./pinchef.db

To be able to run it locally without the need for a database postgress.

virtualenv -p python3 venv
source venv/bin/activate
pip install -r requirements.txt

And to run the app.

uvicorn app.main:app --host 0.0.0.0 --port 8000 --reload

ALL

APP structure

All: application folding organization

Folders:

• ? Alembic
  • ? Versions
  • ? env.py
  • Readme.md
  • script.py.mako
• ? API
  • ? Main.py
  • ? Dependnuncies.py
  • ? Conf
    • ? db.py
  • ? Routes
    • ? users.py
    • ? receives.py
    • ? Shopinglists.py
  • ? Models
    • ? models.py everything: separate them into one for each model
    • ? User.py
    • ? Recep.py
    • ? Shopinglist.py
    • ? item.py
  • ? SCHEMAS
    • ? SCHEMAS.PY ALL: separate them into one for each model
    • ? User.py
    • ? Recep.py
    • ? Shopinglist.py
    • ? item.py

Migrations

connect with Alembric to migrations

Docker

Find a better image for the project

** I have a mistake that marks that I have a Windows file I don't know?

Routes

get:/API/users/ # List of users post:/API/users/ -> Create User Get:/API/USERS/: ID -> To obtain a Put user:/API/USERS/: ID -> UPDATE DELETE:/API/USERS/: ID -> DELETE User

get:/API/receipts/ # Recipe list Post:/Api/receipts/ -> Create recipe get:/API/RECEIVERS/: ID -> To obtain a recipe Put:/API/RECEIVES

get:/api/shopinglists/ # shopping lists list Post:/Api/Shopinglists/ -> Create shopping list get:/Api/Shopinglists/: Id -> To get a shopping list Put:/API/Shopinglists/: Id -> Update Delate:/API/Shopinglists/ Shopinglist

Author: Gerardo Alcántara

Everything: I stayed on the models in a single file like the schemas

Contributors

Thanks Goes toSe Wonderful People (Emoji Key):

Sergio Alejandro Ribera Costa

This Project Follows The All-Contributions Specification. Contributions of Any Kind Welcome!