Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 2.19 KB

README.md

File metadata and controls

53 lines (35 loc) · 2.19 KB
Raw

Recettes

CodeFactor GitHub Actions codecov Website License

A website giving you recipe ideas for an healthy week.

Tired of unique random recipes? Try to get weekly equilibrium!

License

This project is under the GNU AGPLv3 license

Contributing

🍰 I want to add / modify recipe

Doing it quickly:

  • Send a random message to @recipeScrapperBot on Telegram (:warning: the bot might be down if the website is down)
  • Just wait for the moderation to accept it.
  • Find a recipe on Marmiton or 750g
  • Send the link to the bot.
  • The recipe will be checked and added to the website soon!

Doing it manually:

  • Just DM me and I'll add/modify your recipe

🔧 I want to change the way the website works

Don't hesitate to ask for a new feature / report a bug.

Even better, you can work on the project! Run these commands (don't forget virtualenv if are used to these):

git clone https://github.com/EwenQuim/recettes
cd recettes
pip install -r requirements.txt
pre-commit install

I use these pre-commit hooks to standardize the way the project is organized. It might bother you but it's better for everyone -you'll be pleased to contribute to a beautiful code!

  • black
  • flake8
  • pylint
  • gitmoji

Don't hesitate to check the contributing guidelines, and you're ready for making a good PR 🍷