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

https://github.com/phalt/cookiecutter-django-api

A cookiecutter template for a basic Django Web API project.
https://github.com/phalt/cookiecutter-django-api

Last synced: 9 months ago
JSON representation

A cookiecutter template for a basic Django Web API project.

Awesome Lists containing this project

README

          

# cookiecutter-django-api

This provides a cookiecutter template for a Django API project.

Featuring:

- Django 1.8
- Django REST Framework 3.1

## Installation:

- Install [cookiecutter](https://cookiecutter.rtfd.org).

- Use cookiecutter to make a copy:

```
$ cookiecutter https://github.com/phalt/cookiecutter-django-api.git
project_name (default is 'project_name'):
```

- Set things up:

```
cd project_name
make install
```

- Write your models in resources/models.

- Generate and setup your models:

```
make build
```

- Run the server!

```
make serve
```

From here, you can work on the project, create a git repository and push your changes to GitHub. The project is set up to work with Heroku automatically, see [Heroku's guide on creating Django projects](https://devcenter.heroku.com/articles/getting-started-with-django) to get your started.