django-nuit

A front-end framework based upon Zurb Foundation for Django applications, designed for a consistent look and feel across multiple apps and projects.

Documentation can be found at Read the Docs.

Quick Start

Get started with Nuit by following these steps:

• Install Nuit with pip:

  pip install django-nuit

• Add nuit to your INSTALLED_APPS in settings.py:

  INSTALLED_APPS = (
      ...
      'nuit',
      ...
  )

• Nuit relies on django-autoconfig, which requires the following at the end of settings.py:

  from django_autoconfig.autoconfig import configure_settings
  configure_settings(globals())

• In a production environment, add the following setting for django-pipeline (see their documentation for more details):

  PIPELINE_ENABLED = True

• Install the SASS binary in order to compile and compress the CSS. This can't be installed using pip, and will need to be installed manually (usually with gem install sass)

• Run collectstatic:

  manage.py collectstatic

You're now ready to start using Nuit in your templates and apps. Read the documentation for the next steps.

Contributing

To contribute, fork the repo, do your work, and issue a pull request. We ask that contributors adhere to PEP8 standards, and include full tests for all their code.