generator-django-rest

generator-django-rest

A Yeoman generator for a Django REST API (and optionally a React SPA) that makes you efficient, includes features you need in a typical modern web app, yet keeps things simple.

Note: the project is still considered to be in beta until I get a chance to test it on more apps. That said, I am using it in my own projects :)

Features

The philosophy is to include features useful across projects that are tedious to set up from scratch. Some of the cool features are:

• 🚀 quick to launch – start a new project and deploy it to Heroku in 3 commands:

    yo django-rest
    ./scripts/setup.sh
    ./scripts/deploy.sh
  

• ⚡️ productive – start the Django, DB & optionally frontend dev servers easily

    ./scripts/dev.sh
  

• 📜 sane logging – defaults to fail nicely

• 🦄 modern JS – serve static files on / using django-spa & Whitenoise for nice single-page apps using React / Angular / Vue…

• ⛵️ monorepo - option to automatically set up a create-react-app frontend for you in the same git repo with everything integrated under the mantra one app, one repo, one dyno

• 📦 Heroku-friendly packaging – if you're using the built-in React frontend, deploy.sh minifies the frontend and packages it up with Django into a separate prod branch ready for deployment as a Django web app (that gets deployed to Heroku by default)

• 🤓 12-factor config – environment variable configuration

  • define a variable in .env for dev e.g. REDIS_URL=redis://localhost:6379/0
  • use it in settings.py, e.g. CELERY_RESULT_BACKEND = env('REDIS_URL')
  • set variables on the prod server (just works™ with Redis on Heroku)

• 🔋 batteries included

  • snapshottest quickly write tests by taking API snapshots.
  • Celery with a Redis backend – cause you'll need an async task queue
  • Backblaze B2 media file storage backend (optional)

• 🐶 familiar – check out the rough project file layout, it's much like django-admin startproject myproject would set it up (only repeats the project name twice, i.e. ~/code/myproject/myproject/settigns.py)

• 🚢 Docker support – docker-compose up to get a working environment with a database

• ⚛️ GraphQL – interactive API with filtering and nested queries

See CHANGELOG.md for a full release history with all the features.

Getting Started

To begin, you need to install node.js. Once you have that, you need Yeoman pre-installed. Yeoman lives in the npm package repository. You only have to ask for him once, then he packs up and moves into your hard drive.

npm install -g yo

Then, we need the django-rest generator, i.e. plug-in. You install generator-django-rest from npm.

npm install -g generator-django-rest

Finally, for every new project you would initiate the generator in an empty folder.

mkdir myproject
cd myproject
yo django-rest

Now check HACKING.md for extra instructions.

License

MIT

Changelog

v0.8.1

8 August 2018

• Snapshot testing #11
• add snapshottesting to requirements, have Docker build install dev requirements c5019ed
• add test for building application and running app tests 42e8cd5
• defubar docker routines be42661