generator-django's Introduction

generator-django

A generator for Yeoman.

Demo

A demo application can be found here.

Getting Started

To install generator-django from npm, run:

$ npm install -g generator-django

Then make a virtualenv and activate it:

$ virtualenv myproject --no-site-packages
$ source myproject/bin/activate

Finally, make your project directory and initiate the generator:

$ mkdir myproject && cd myproject
$ yo django

Generators

Available generators:

django
startapp
model

Note: Generators are to be run from the root directory of your app.

Django

Sets up a new Django project.

Example:

$ yo django

Startapp

Sets up an app folder.

Example:

$ yo django:startapp

Model

Generates a Django model for you.

Example:

$ yo django:model

What do you get?

You get the following directory structure:

.
├── apps
├── bin
│   └── watchmedo.sh
├── bower.json
├── fabfile.py
├── __init__.py
├── libs
├── package.json
├── README.md
├── requirements
│   ├── COMMON
│   ├── DEVELOPMENT
│   ├── PRODUCTION
│   └── TESTING
├── settings
│   ├── common.py
│   ├── development.py
│   ├── __init__.py
│   └── testing.py
├── static
│   ├── css
│   ├── img
│   ├── js
│   └── vendor
│       └── bower
└── templates
    └── layout