https://github.com/diaga/django-api-template

Template for creating robust APIs with django rest framework!
https://github.com/diaga/django-api-template

api django-rest-framework docker postgresql python template test-driven-development travis-ci

Last synced: 2 months ago
JSON representation

Template for creating robust APIs with django rest framework!

• Host: GitHub
• URL: https://github.com/diaga/django-api-template
• Owner: Diaga
• License: mit
• Created: 2019-07-27T09:33:13.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-08-09T20:34:42.000Z (almost 7 years ago)
• Last Synced: 2025-02-05T13:34:33.079Z (over 1 year ago)
• Topics: api, django-rest-framework, docker, postgresql, python, template, test-driven-development, travis-ci
• Language: Python
• Homepage:
• Size: 21.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# django-api-template

[![Build Status](https://travis-ci.com/Diaga/django-api-template.svg?branch=master)](https://travis-ci.com/Diaga/django-api-template)

Template for creating robust APIs with django rest framework!

This template contains configured Dockerfile, docker-compose and .travis.yml files.

## Project Structure

All models are placed in models.py file in 'app' folder along with unit tests.

All unit tests are placed in the 'tests' folder inside each app.

Each section of the API is allotted its own app inside django.

## Setup

Update requirements.txt file with latest versions of libraries.

Set suitable user & password for database in docker-compose file.

## Commands

* Start new app:

    ```shell script

    python manage.py template_startapp 

    ```

* Run unit tests:

    ```shell script

    python manage.py test && flake8

    ```

## ToDo

Add commands to easily create customized user