The repository for Project Bluebottle, the crowdsourcing framework initiated by the 1%Club.

For those who want to contribute to the BlueBottle project, it's easy to get started:

1. Make sure you have a recent Python distro (2.7+ recommended).
2. Make sure (a recent) virtualenv is installed.
3. Fork and/or clone the repository.
4. Navigate to your local repository directory.

5. Create a virtual environment within the repository directory, for example:

   $ virtualenv env
   $ source env/bin/activate

6. Install the project:

   $ python setup.py develop

7. You're ready to roll now, baby!

The BlueBottle test suite can be run completely using:

python setup.py test

*Watching with Guard*

The tests can be automatically run when changed using guard. To install and run do:

gem install bundler bundle bundle exec guard start

Guard will run the whole test suite when starting, run specific test files when they change, and run an apps test suite when the apps code changes.

*Frontend Javascript*

From the root of the application (node/npm required):

npm install grunt

This will install some npm & bower packages for dev & testing, and run the tests headless with PhantomJS using Karma. Karma is watching the test/ directory for changes.

For those who want to use BlueBottle as kickstart for their own website, it's easy to add BlueBottle to your Django project.

1. Install the latest development version:

   $ pip install -e git://github.com/onepercentclub/bluebottle.git#egg=bluebottle