Skip to content

Commit

Permalink
Merge pull request #5 from yulio94/feature/readme_update
Browse files Browse the repository at this point in the history
feat: readme update.
  • Loading branch information
yulio94 committed Dec 22, 2020
2 parents d44b777 + 5a8621f commit 7701c50
Showing 1 changed file with 37 additions and 6 deletions.
43 changes: 37 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,42 @@
# Cookiecutter Django Rest
This is my own (custom) cookiecutter for project with Django Rest Framework
Do you need a ready to production Django rest framework template?. It's our first objective with this
repository.

## How work dependencies?
Dependencies work with [pipenv](https://pipenv.pypa.io/en/latest/)
This repository use [cookiecutter](https://cookiecutter.readthedocs.io/en/1.7.2/index.html) for provide you a quick start
with Django rest framework.

## Features
* Python 3.8+
* Django 3.0+
* PotsgreSQL 13.1+
* Local development fully dockerized via docker-compose.
* Django rest framework.
* Optimized local, test and production settings.
* Multi-task, async tasks and task monitoring.
* [Celery 4.4.6](https://docs.celeryproject.org/en/stable/)
* [Redis 6.0.9](https://redis.io/)
* [Flower 1.0.0](https://flower.readthedocs.io/en/latest/index.html#)
* Testing with unittest or pytest.
* Dependencies work with [pipenv](https://pipenv.pypa.io/en/latest/).

And more incoming...

## How start
You need to install [cookiecutter](https://cookiecutter.readthedocs.io/en/1.7.2/installation.html), one way to do that is:
```
pip install pipenv
pip install cookiecutter
```
See more ways to install in [cookiecutter installation](https://cookiecutter.readthedocs.io/en/1.7.2/installation.html).

Then, scaffold your project:
```
cookiecutter gh:yulio94/cookiecutter-django-rest
```
An example in [cride repository](https://github.com/yulio94/cride).

### Thanks to:
* @pablotrinidad
* @pydanny
* @agconti
* @platzi

## where is listed my dependencies?
All dependencies are listed into Pipfile

0 comments on commit 7701c50

Please sign in to comment.