Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dipto0321/foody-recipe-app-api

Foody recipe API source code.
https://github.com/dipto0321/foody-recipe-app-api

authentication django-rest-framework docker restful-api tdd travis-ci

Last synced: about 1 month ago
JSON representation

Foody recipe API source code.

Host: GitHub
URL: https://github.com/dipto0321/foody-recipe-app-api
Owner: dipto0321
License: mit
Created: 2020-02-19T17:49:28.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2020-10-23T08:11:27.000Z (about 4 years ago)
Last Synced: 2024-10-18T20:18:58.957Z (3 months ago)
Topics: authentication, django-rest-framework, docker, restful-api, tdd, travis-ci
Language: Python
Homepage: https://foody-recipe-app-api.herokuapp.com/api/doc/
Size: 295 KB
Stars: 4
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Welcome to foody-recipe-app-api 👋

![foody_recipe_api](banner.png)

![Version](https://img.shields.io/badge/version-0.1-blue.svg?cacheSeconds=2592000)

![GitHub Pipenv locked Python version](https://img.shields.io/github/pipenv/locked/python-version/dipto0321/foody-recipe-app-api)

![GitHub Pipenv locked dependency version](https://img.shields.io/github/pipenv/locked/dependency-version/dipto0321/foody-recipe-app-api/django?style=plastic)

![GitHub Pipenv locked dependency version](https://img.shields.io/github/pipenv/locked/dependency-version/dipto0321/foody-recipe-app-api/djangorestframework?style=plastic)

![GitHub Pipenv locked dependency version](https://img.shields.io/github/pipenv/locked/dependency-version/dipto0321/foody-recipe-app-api/gunicorn?style=plastic)

[![Build Status](https://travis-ci.org/dipto0321/foody-recipe-app-api.svg?branch=master)](https://travis-ci.org/dipto0321/foody-recipe-app-api)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/414457f95b08424689ac40a6d651fa80)](https://www.codacy.com/manual/dipto0321/foody-recipe-app-api?utm_source=github.com&utm_medium=referral&utm_content=dipto0321/foody-recipe-app-api&utm_campaign=Badge_Grade)

![GitHub last commit](https://img.shields.io/github/last-commit/dipto0321/foody-recipe-app-api?style=plastic)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

[![Twitter: Diptokmk47](https://img.shields.io/twitter/follow/Diptokmk47.svg?style=social)](https://twitter.com/Diptokmk47)

> It's a foddy app api containes all the food recipe data

## Install

  - Install docker and docker-compose

  - Run this comman 👇

    ```sh

    docker build .

    docker-compose build

    ```

## Usage

  **Local**

  - First run 

    ```sh

    docker-compose up

    ```

  - Then goto `http://127.0.0.1:8000/api/doc/` for accessing API doc

  

  **Live**

  - [Live Doc](https://foody-recipe-app-api.herokuapp.com/api/doc/)

  - Browsable Apis

    - [User Create](https://foody-recipe-app-api.herokuapp.com/api/user/create/)

    - [User Login for getting token](https://foody-recipe-app-api.herokuapp.com/api/user/token/)

    - [User Profile (Authorization required)](https://foody-recipe-app-api.herokuapp.com/api/user/me/)

    - [Recipe View List (Authorization required)](https://foody-recipe-app-api.herokuapp.com/api/recipe/recipes/)

    - [Tag View List (Authorization required)](https://foody-recipe-app-api.herokuapp.com/api/recipe/tags/)

    - [Ingredients View List (Authorization required)](https://foody-recipe-app-api.herokuapp.com/api/recipe/ingredients/)

  

    [**Note:** Check live doc for detail information ☝️ ]

## Run tests

```sh

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

```

## Author

👤 **Dipto Karmakar**

* Website: https://diptokarmakar.me/

* Twitter: [@Diptokmk47](https://twitter.com/Diptokmk47)

* Github: [@dipto0321](https://github.com/dipto0321)

* LinkedIn: [@diptokarmakar](https://linkedin.com/in/diptokarmakar)

## Show your support

Give a ⭐️ if this project helped you!

***

_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_