HowlingByte / Marmit65

Quick and easy cooking recipes website.

📑 Table Of Contents

• About The Project
• Built With
• Getting Started
• Deployment
  • Prerequisite
  • Installation
• Contributing
• License
• Authors
• Acknowledgements

📝 About The Project

• Features of Marmit@
  • 🏠 Home Page
    • Display a list of recipe families with their images.
    • Navigate to the pages of each family to see associated recipes.
  • 🍲 Family Pages
    • Display a list of recipes for a specific family. View details of each recipe by clicking on its name or image.
  • 📜 Recipe Pages
    • Display details of a specific recipe, including ingredients and steps.
    • Provide information on cooking time, difficulty, and number of servings.
  • 🔍 Recipe Search *Search for recipes using keywords.
    • View a list of matching recipes.
• User Interface
  • 🎨 Modern and Stylish Design
    • Visually appealing and user-friendly interface.
  • 📱 Responsive Design
    • Compatible with both iOS and Android devices and on PC.
  • ✨ Regular Updates
    • Continuously improves with new features and enhancements.

🛠️ Built With

This website use Bottle, a micro python web-framework bottlepy/bottle.

🚀 Getting Started

It's a school project, so it's not perfect. We are two students working on this project. We are French, so the website is in French. We are not professionals, so the code is not perfect. We are open to any suggestions, so don't hesitate to contact us. We are not responsible for any problems that may appear.

🔧 Deployment

Prerequisite

You need to install the dependencies with the following commands:

pip install -r requirements.txt

Installation

Decompress the archive into a directory. Make sure you have the requirements installed. Run this main.py and open a web browser. Connect to localhost:8080, and you're ready to go!

🤝 Contributing

We are open to any suggestions, so don't hesitate to contact us. We are not responsible for any problems that may appear.

Pull Requests (PRs)

1. Make sure you have an up-to-date copy of the code by cloning this repository to your machine.
2. Create a new branch for your work:

git checkout -b your-branch-name

3. Make your changes and additions.
4. Commit your changes:

git commit -m "Description of your changes"

5. Push your changes to GitHub:

git push origin your-branch-name

6. Visit the repository's page and create a Pull Request, explaining in detail your changes and why they are beneficial for the project.

Issues

If you encounter problems or have suggestions, feel free to open an issue in the repository.

📝 License

Distributed under the Mozilla Public License 2.0. See LICENSE for more information.

👥 Authors

• @Hidden-Warden — French student in BTS SIO
• @Ahhj93 — French student in CPGE MP2I

🙏 Acknowledgements

• bottlepy/bottle