Code Monkey home page Code Monkey logo

generator-django-kaiju's Introduction

generator-django-kaiju Build Status

Yeoman generator for Django that includes a live reloading development server, sass support, Foundation 5 and Heroku integration.

Getting Started

What does it do?

This generator...

  • Scaffolds your Django app with good conventions. (core app, multiple settings, etc.)
  • Sets up sass
  • Sets up live reloading development server via grunt
  • Configures a build task that minifies and concatenates your css/js/images.
  • Sets up Foundation 5
  • Sets up Font Awesome
  • Sets up project for Heroku hosting (Procfile, post-compile scripts)

Usage

Install generator-django-kaiju:

npm install -g generator-django-kaiju

Make a new directory, and cd into it:

mkdir mydjangoproject && cd mydjangoproject

Make a new virtualenv and activate it (Optional)

virtulenv venv
source venv/bin/activate

Or if you're using virtualenvwrapper

mkvirtualenv myvenv

Run yo django-kaiju, optionally passing your project's name

yo django-kaiju [appname]

Grunt tasks

  • python manage.py gruntserver - starts the Django development server and the live reloading server.
  • grunt - compiles sass and runs autoprefixer.
  • grunt build - concatenates, copies and minifies css/js/images into core/assets/dist

Heroku

A few things need to be setup in your Heroku app

Initialize a git repo

git init

Add everything and commit

git add -A
git commit -m "Initial commit for mydjangoproject"

If you don't have one yet, create your app

heroku create

Set DJANGO_SETTINGS_MODULE to <your_app_name>.settings.prod

heroku config:set DJANGO_SETTINGS_MODULE='<your_app_name>.settings.prod'

Set DJANGO_SECRET_KEY to a django secret key. (You can generate one here)

heroku config:set DJANGO_SECRET_KEY='<secret key>'

Finally, explicitly set your buildpack to use Heroku's Multi Buildpack

heroku config:set BUILDPACK_URL='https://github.com/heroku/heroku-buildpack-multi'

You can now push your app to heroku

git push heroku master

Changelog

1.3

  • Added autoprefixer
  • Added gruntserver management command
  • Updated used grunt-sass version
  • Set the fallback DJANGO_SETTINGS_MODULE to <app>.settings.dev for convenience

1.2

  • Switched over to using multi buildpacks for faster deployment

1.1

  • Removed the need for django-admin to be in PATH during scaffolding

1.0

  • Initial release

License

MIT

generator-django-kaiju's People

Contributors

mixxorz avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.