Skip to content

Latest commit

 

History

History
57 lines (45 loc) · 3.11 KB

README.md

File metadata and controls

57 lines (45 loc) · 3.11 KB

cookiecutter-django-rest

cookiecutter-django-rest

a factory for building bleeding edge, best practiced, scalable, rest apis

Build Status Dependencies Python 3

You need to make a scalable api on a deadline. You deeply care about the quality of your work. cookiecutter-django-rest takes care of the details so you can focus on making your api awesome. Scaffolding a project takes seconds and it gives you authentication, user accounts, and the docs and tests to support them. Just add your own resources to the api and start shipping. ✨ 💅

Highlights

  • Modern Python development with Python 3.6+
  • Bleeding edge Django 2.1+
  • Fully dockerized, local development via docker-compose.
  • PostgreSQL 9.6+
  • Start off with full test coverage, continuous integration, and continuous deployment.
  • Complete Django Rest Framework integration
  • Auto deployment to Heroku included. Also since we're using containers we can easily deploy anywhere.
  • Always current dependencies and security updates enforced by pyup.io.
  • A slim but robust foundation -- just enough to maximize your productivity, nothing more.

Quick Start

Install cookiecutter:

brew install cookiecutter

Scaffold your project:

cookiecutter gh:agconti/cookiecutter-django-rest

Scaffolding

Example of the result: https://github.com/agconti/piedpiper-web

Try creating a user!

curl -d '{"username":"'"$RANDOM"'", "password":"test", "email":"[email protected]", "first_name":"test", "last_name":"user"}' \
     -H "Content-Type: application/json" \
     -X POST https://piedpiper-prod.herokuapp.com/api/v1/users/