Cookin' 🧑‍🍳📓💟

Contents

• 1. About 💻
• 2. Application's links 🔗
• 3. General Functionalities ⚙️
• 4. Technologies 🧰
  • 4.1 Requisites ☑️
• 5. Developers' Team 🧑‍💻
• 6. Terms of Use 📜

1. About 💻

Cookin' affective recipes is an application that focuses on creating and/or sharing affective recipes that the user can access anytime, like a private book of recipes.

The registered user is allowed to consult, to rate and to save as favorite other users' recipes once these recipes are shared with others. User can also add to favorite his own recipes but can only rate others' recipes.

This API was developed in order to storage the recipes' data as well as the registered users' data and to allow users to log in the app in order to enjoy all the application's features described above.

All routes require Bearer token authentication (except register and login). Access token can be obtained in login successful response.

This API contains 6 routes and 18 endpoints. For more detailed information about the API and its endpoints, please consult API Documentation in Application links section.

🎓 Project developed as Capstone of Q3 back end module of the Fullstack Developer Course of Kenzie Academy Brasil.

2. Application's links 🔗

• API Documentation
• API Deploy in Heroku

3. General Functionalities ⚙️

• Once registered in Cookin' app and signed in, users can:
  • update their name, gender or profile photo;
  • create new recipes of their own and keep them private;
  • update recipe's data, like title, ingredients, instructions, category, preparation time, difficulty, portion size and recipe image;
  • consult their own private recipes, shared recipes in Cookin' community and recipes added to favorites;
  • consult users of the Cookin' community info;
  • choose whether to share private recipes with the Cookin' community;
  • add recipes to favorites, their own recipes or shared recipes by other users from Cookin' community;
  • rate shared recipes from Cookin' community;
  • filter recipes by title, category, difficulty, preparation time and portion size;

4. Technologies 🧰

• Python
• Flask
• python-dotenv
• Flask-jwt-extended
• Flask SQLAlchemy
• PostgreSQL
• Flask Migrate
• Marshmallow

4.1 Requisites ☑️

• Python above version 3.9.6;
• Package manager PIP;
• PostgreSQL database;

5. Developers' Team 🧑‍💻

Emily Regolão

Larissa Oliveira

Lucas Gasque

Manoela Cunha

Raissa Toledo

Roberto Bressanelli

6. Terms of Use 📜

This is an Open Source project for educational and non-commercial purposes.

License type: GPL