Skip to content

RegisGraptin/CookingPlanner

Repository files navigation


Logo

Cooking Planner

Elevate your meals, simplify your life with Cooking Planner

Report Bug · Request Feature

About The Project

Cooking Planner is a web application designed to simplify your meal planning process. Whether you're a busy professional or a homemaker, the application recommends you a variety of recipes to cook that fit your tastes and plan for the week.

With Cooking Planner, you can easily organize your weekly meals, create shopping lists, and plan your cooking schedule in advance. This means you can avoid the stress of last-minute meal planning and save valuable time during the week.

The application offers a wide range of recipe options, catering to different tastes and dietary preferences. From quick and easy meals to more elaborate dishes, you can find the perfect recipe to suit your needs.

Say goodbye to the hassle of meal planning and let Cooking Planner take care of it for you. Plan your meals in advance with ease and enjoy stress-free cooking throughout the week.

"Elevate your meals, simplify your life with Cooking Planner".

"From planning to plate - Cooking Planner has you covered"

Build With

This web application is currently composed of two parts:

  • A backend written in Python using FastAPI.
  • A frontend written in JavaScript using NuxtJS, a framework based on VueJS.

The parts are defined in the corresponding repository.

Getting Started

At the moment, the application is not fully ready. We are working on it. Currently, you can run with docker the backend through docker compose. In future versions, we will also implement the frontend. Nevertheless, you can still run the application by going to the sub repository to see instructions.

docker compose up

Roadmap

[] TODO

Contributing

Thank you for your interest in contributing to this project! We welcome any and all contributions that will help improve this project and make it more useful to the community. If you have any suggestions or ideas for this project, please feel free to open an issue and share your thoughts. We value your feedback and will do our best to respond to it.

Linter & Testing

In our backend, our project utilizes pylint for linting and pytest for testing. We have set up a commit hook to ensure that all code changes pass both the linter and test suite before commiting your work.

License

Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published