Skip to content

memetics19/Django-Recipe-API

Repository files navigation

Django-Recipe-API

A REST-Full API built with Django Rest Framework. The API will retrieve recipes and ingredients needed for the particular recipe with user authentication and authentication handling.

Sandeep Hacked here. Follow me on twitter @sandeep_sriniv

Trigger

Django Rest Framework

Build Status CircleCI License GitHub closed issues GitHub pull requests GitHub followers GitHub repo size GitHub watchers GitHub contributors forthebadge made-with-python

How to Setup the Local Server

  1. Clone the Repo by following command git clone git@github.com:memetics19/Django-Recipe-API.git . if you haven't add ssh key probably add by clicking this link

  2. Install Docker if you haven't installed it, yet. You can install by clicking this link

  3. Use this command to install the dependencies docker-compose build

  4. Use this command to run the server docker-compose up

  5. Navigate to 127.0.0.1:5000

API Endpoints

Create Profile: api/create/create

Create Token: api/create/token

Modify Account: api/create/me

Recipe Tags: api/recipe/

How to run tests

Running the tests can be done by following command

docker-compose run app sh -c "python manage.py test && flake8"

One Click Deployment

Deploy Deploy to Azure amplifybutton Deploy

Planning - TO DO

To know what's the further development of the project Check Notes

Dependencies

  1. Django
  2. DjangoRestFrameWork
  3. Flake8

Heroku Dependencies 4. Gunicorn 5. Whitenoise

Note

Docker does'nt work on Windows 10 Home Edition

Trigger this

trigger trigger this scdsvddsvdsvdsvsv

trigger this sssss

sdvsddvdvdbdbffdfbdfbdbdbddbdbd