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. Create a secrets.py base on secrets.py.example

7. Install the project:

   $ python setup.py setup
   $ python manage.py sync_schemas --shared --settings=bluebottle.settings.testing
   $ python manage.py migrate_schemas --shared --settings=bluebottle.settings.testing
   $ ... createtenant
   $ ...

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

The BlueBottle test suite can be run completely using:

1. Get the latest Geodata

   $ curl https://geolite.maxmind.com/download/geoip/database/GeoLiteCountry/GeoIP.dat.gz | gunzip - > GeoIP.dat

2. Install the dependencies

   $ pip install -e .[test,dev]

3. Run the tests

   $ python manage.py test --settings=bluebottle.settings.testing

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