https://github.com/axiacore/generator-django-axiacore

Base template for a Django project
https://github.com/axiacore/generator-django-axiacore

Last synced: 3 days ago
JSON representation

Base template for a Django project

• Host: GitHub
• URL: https://github.com/axiacore/generator-django-axiacore
• Owner: axiacore
• Archived: true
• Created: 2015-02-11T16:02:31.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-05-08T13:21:51.000Z (over 9 years ago)
• Last Synced: 2024-08-09T08:59:03.313Z (3 months ago)
• Language: JavaScript
• Size: 1.86 MB
• Stars: 20
• Watchers: 13
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# generator-django-axiacore 

Base template for django projects at [AxiaCore](http://axiacore.com), includes Gulp build with Compass and Live Reload. Also browser dependencies using Bower.

[Project Page](http://axiacore.github.io/generator-django-axiacore/)

[View on NPM](https://www.npmjs.com/package/generator-django-axiacore)

![materialize](https://raw.githubusercontent.com/AxiaCore/generator-django-axiacore/master/images/demo.png)

### Quick start

```bash

# Create a new folder for your project

$ mkdir my-awesome-project && cd my-awesome-project

# Install yeoman and django-generator

$ sudo npm install -g yo generator-django-axiacore

# Use the generator

$ yo django-axiacore

# Fire up your new enviroment

$ workon my-awesome-project_app

# Make your migrations

$ ./manage.py migrate

# Run!!!

$ ./manage.py runserver 0.0.0.0:8000

```

### Adding Bootstrap or Materialize 

You can setup the project to use [Materialize](http://materializecss.com/) or [Bootstrap](getbootstrap.com).

![setup](https://raw.githubusercontent.com/AxiaCore/generator-django-axiacore/master/images/materialize.png)

### Subgenerators

Using the subgenerator *startapp* `yo django-axiacore:startapp` you can create a new app with scaffold *Views* and *Urls*.

```bash

$ yo django-axiacore:startapp

```

![startapp](https://raw.githubusercontent.com/AxiaCore/generator-django-axiacore/master/images/startapp.png)

### Contributing

We love contributions, so, don't hesitate in creating an issue or sending us a pull request.

### Development

The main generator [file](https://github.com/AxiaCore/generator-django-axiacore/blob/master/app/index.coffee) is written in [CoffeeScript](http://coffeescript.org), and we use [Gulp](http://gulpjs.com/) to compile it. 

To set the generator up just clone the repository and run:

```bash

# Install dependencies.

$ npm install 

# Run tasks.

$ gulp

# Hack...

```

### Development

Main project file is written in [CoffeeScript](coffeescript.org) so we use Gulp for building it.

It's located in `app/index.coffee`.

```bash

# Run gulp, which will watch for changes in `.coffee` files.

$ gulp

```

### Technologies

* Bower

* Gulp

* Sass

* Compass

### Dependencies

* Node

* Npm

* Python

* Ruby