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

https://github.com/diaga/mars-server

Django Server for MARS project.
https://github.com/diaga/mars-server

Last synced: 8 months ago
JSON representation

Django Server for MARS project.

Awesome Lists containing this project

README

          

# django-api-template
[![Build Status](https://api.travis-ci.com/Diaga/MARS-Server.svg?token=ymmkUFtxjsN4DBFG6epB&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