Skip to content

A boilerplate project for quickly developing API with Django.

Notifications You must be signed in to change notification settings

anujkarn002/django-boilerplate

Repository files navigation

Django API Template

This is a template for building backend API.

Features

  • Docker
  • Django
  • Django Rest Framework
  • Authentication Endpoints
  • Testing base

Install

The only system requisites are docker and docker-compose, everything else is handled inside the docker container.

  1. make setup (or run the setup commands in Makefile if you don't have make installed.)
  2. docker-compose up or docker-compose up -d
  3. docker-compose exec django ./manage.py migrate

Usage

Running django commands

Since the project is running in a docker container you can run django commands with docker-compose exec django ./manage.py <command>.

Running tests

You can run tests with make test or run with extra options using a docker-compose exec script.

Owning files

When generating new files through startapp or makemigrations for instance, the files will not be owned by you and you won't have permission to modify. You can fix that by running make chown.

About

A boilerplate project for quickly developing API with Django.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages