Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 854 Bytes

README.md

File metadata and controls

37 lines (25 loc) · 854 Bytes

Recipe App API

This is a recipe RESTful API written with Django and Django REST framework based on Test-driven development built over Docker.

This project is a sample app that can be used for other projects.

Features

  • Setting up the project with Docker
  • Configuration for Travis CI and Coveralls
  • Use a fully custom user model instead of the default Django User model
  • Endpoints for creating and managing users, tags, ingredients, and recipes
  • Filtering to list endpoints
  • Image upload for recipes
  • Lots of unit tests

Usage

To start project, run:

cd <project_dir>
docker-compose build
docker-compose up

The API will be available at http://127.0.0.1:8000

Test

To test project, run:

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