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

build status

1. Make sure you have a recent Python distro (2.7+ recommended)
2. Make sure (a recent) pip is installed
3. Make sure (a recent) virtualenv is installed
4. Clone the repo

5. In the repo dir, execute the following (tested with Bash, might work with others as well):

   ./prepare.sh

6. Configure your database in bluebottle/settings/secrets.py.

7. Activate the newly created environment in `env`:

   source env/bin/activate

8. Update database structure:

   ./manage.py syncdb --migrate

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

Requirements for the virtual environment can be found in requirements.txt and the environment itself is in env in the project's root dir. It is automatically ignored through .gitignore.

Translations are managed using Transifex. Feel free to contribute and collaborate at the Transifex project page.

The project has settings for every environment in the DTAP scheme. They can be found in `bluebottle/settings`:

• `jenkins.py`: Settings for continuous integration environment.
• `dev.py`: Settings for development environment.
• `testing.py`: Settings for testing environment.
• `staging.py`: Settings for staging environment.
• `production.py`: Production settings.

Specific settings can be used by setting the environment variable DJANGO_SETTINGS_MODULE to `bluebottle.settings.environment`:

export DJANGO_SETTINGS_MODULE=bluebottle.settings.production

Apart from these environment specific settings, the following settings exist:

• `defaults.py`: Project defaults used in any settings environment.
• `secrets.py`: Used for storing passwords, API keys etcetera, kept out of the scope of Git.
• `local.py`: Local settings overrides, based off defaults.py. Not stored in Git.

If no settings are explicitly chosen using DJANGO_SETTINGS_MODEL, the local.py settings are loaded, defaulting to override defaults.py settings.

When not using the default settings imported from local.py, you must ensure that local.py is an empty file otherwise the site will not work properly.

As to allow for convenient overriding a chaining import pattern is used, where the used settings (ie. local.py) imports more generic settings which, in turn, imports more generic settings. The exception being secrets.py which should be minimal and should not require other settings to be available. For more information on the used settings pattern, consult the SplitSettings page in the Django Wiki.

Some models have default data which can be loaded after you run syncdb with this command:

./manage.py loaddata <name of json file without extension>

For example, this command loads the data for the Bluebottle geo app:

./manage.py loaddata region_subregion_country_data

You can find a list of data files with this command run from the bluebottle directory:

find apps -name \*.json

Project Bluebottle is distributed under a 3-clause BSD license. For more information, please refer to the license.