Dance weekend management app. In development. Getting a rename later.
Dance weekend management app. In development. Getting a rename later.

Development
=============

Prerequisites
-------------

The installation instructions below assume you have the following software on your machine:

* `Python 2.7.x <http://www.python.org/download/releases/2.7.6/>`_
* `Ruby <https://www.ruby-lang.org/en/installation/>`_ 
* `Pip <https://pip.readthedocs.org/en/latest/installing.html>`_
* `virtualenv <http://www.virtualenv.org/en/latest/virtualenv.html#installation>`_ (optional)
* `virtualenvwrapper <http://virtualenvwrapper.readthedocs.org/en/latest/install.html>`_ (optional)

Installation instructions
-------------------------

If you are using virtualenv or virtualenvwrapper, create and activate an environment. E.g.,

.. code:: bash

    mkvirtualenv brambling # Using virtualenvwrapper.

Then, to install:

.. code:: bash

    # Clone django-brambling to a location of your choice.
    git clone https://github.com/littleweaver/django-brambling.git

    # Install django-brambling.
    pip install --no-deps -e django-brambling

    # Install python requirements. This may take a while.
    pip install -r django-brambling/test_project/requirements.txt

Modifying Brambling's CSS files requires `SASS <http://sass-lang.com/>`_, `Compass <http://compass-style.org/>`_, and `Bootstrap SASS <http://getbootstrap.com/css/#sass>`_. If you plan to make changes to CSS files, but don't have those installed:

.. code:: bash
    
    gem install bundler # Ensure you have Bundler. May need sudo.
    bundle install --gemfile django-brambling/Gemfile # Install Ruby requirements.

Get it running
--------------

.. code:: bash

    cd django-brambling/test_project
    python manage.py syncdb    # Create/sync the database.
    python manage.py runserver # Run the server! 

Then, navigate to ``http://127.0.0.1:8000/`` in your favorite web browser!

Modifying the Styles
--------------------

Do not modify any of the files within ``django-brambling/static/brambling/css/``. That directory is managed by Compass. Instead, edit the compass source files in ``django-brambling/sass/``. You will need to use the Compass command line tool to compile stylesheets. E.g.,

.. code:: bash

    cd django-brambling/brambling # Ensure you are in the directory with config.rb.
    compass watch         # Watch the sass directory for changes.

Or use `Compass.app <http://compass.kkbox.com/>`_.

Add setup docs (from littleweaver/django-argus)
Add setup docs (from littleweaver/django-argus)

littleweaver/django-brambling#3
