Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 1.34 KB

README.md

File metadata and controls

54 lines (34 loc) · 1.34 KB
Raw

SmileCook Recipe API

SmileCook Recipe API is a RESTful API designed to provide access to a collection of recipes. It allows users to perform various operations such as fetching recipes, adding new recipes, updating existing recipes, and deleting recipes.

Features

  • Get Recipes: Retrieve a list of recipes with details such as name, ingredients, instructions, and more.
  • Add Recipe: Add a new recipe to the database.
  • Update Recipe: Modify an existing recipe.
  • Delete Recipe: Remove a recipe from the database.

Installation

  1. Clone the repository:

    git clone https://github.com/Just2Deep/recipe_api.git

  2. Navigate to the project directory:

    cd recipe_api/smilecook

  3. Create Virtual env & Install dependencies:

    python -m venv venv
source venv/Scripts/activate
pip install -r requirements.txt

  4. Run the app:

    python main.py

API Endpoints

check this for api documentation

Response Format

The API returns JSON-formatted responses with appropriate status codes.

Contributing

Contributions are welcome! If you have any ideas for improvements or new features, feel free to submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.