lucky-7865/recipe-app-backend

Recipe App Backend

A fully functional backed for recipe app which can be used by mobile or web applications. A user can perform CRUD operations i.e create, read, update and delete a recipe, apart from this user can filter out recipes based on tags and ingredients.

ER Diagram of the Application

CI/CD Workflow Diagram

Run Locally

Python, Docker and docker-compose must be installed in your system to run this application. The installation commands/link for python and docker are as follows:

Python : https://www.python.org/downloads/

Docker : https://docs.docker.com/desktop/install/windows-install/

docker-compose: https://docs.docker.com/compose/install/

Step 1: Clone the project

  git clone https://github.com/lucky-7865/recipe-app-backend.git

Step 2: Go to the project directory

  cd recipe-app-backend

Step 3: Install dependencies

  pip install -r requirements.txt

Step 4: Start the server

  docker-compose up

The server will get Start on localhost:8080. You can access the documentation of the api on http://localhost:8000/api/docs/ while the server is ON

The API documentation will looks like:

You can play around with the APIs as per your need