/generator-django

A Yeoman generator for Django.

Primary LanguageJavaScriptMIT LicenseMIT

generator-django Stories in Ready Build Status NPM version

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

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

MIT License

Bitdeli Badge