Web portal for collaboration of community volunteers with organizations and institutions.

Usage of virtualenv is recommended. Assuming you use Virtualenvwrapper:

mkvirtualenv --no-site-packages venv_name

To install project dependencies use pip and choose the correct file (production, development, etc.)

pip install -r requirements/dev.txt

Copy the Local Configuration file:

cp etc/local_config.yaml.sample local_config.yaml
vim local_config.yaml

Fill the Local Configuration Values. To generate "secret_key", you can use head -c 64 /dev/urandom | base64 -w 0 For Windows users may be used simple:

python -c "import uuid; print str(uuid.uuid4()).replace('-', '')"

If the site is supposed to be served under different domain than volontulo.org or volontuloapp.org and you are not in development environment, fill the "allowed_host" value. Otherwise it can be left blank.

The project uses PostgreSQL 9.4 database.

In Debian / Ubuntu systems:

# apt-get install postgresql-9.4

Install psycopg2 driver dependency:

# apt-get install libpq-dev

# su - postgres
$ psql
postgres=# CREATE ROLE <database_user> WITH ENCRYPTED PASSWORD <db_user_password>;
postgres=# CREATE DATABASE <database_name> WITH OWNER <database_user>;

While running tests each time the database is created and destroyed. To allow that:

postgres=# ALTER USER <database_user> CREATEDB;

To leave postgres command line:

postgres=# \q

Don't forget to fill the database credential in the local_config.yaml file.

Gulp is used to prepare and serve all static files into /apps/volontulo/static/volontulo so Django can use them

cd /apps/volontulo
npm install

Windows can have problems with unix paths, so it is practical to install Gulp globally (with sudo on linux)

npm install -g gulp

In development

gulp watch

Otherwise

gulp build

To convert svg icons to base64 format that ultimately is compiled to CSS, use:

gulp build_icons

Icons in .svg format should be placed at \volontulo\apps\volontulo\frontend\icons\.
That will allow their usage in SCSS like so: @extend %asterisk-icon; as an element background.

Choose the appriopriate settings file
Run server

python manage.py runserver --settings=volontulo_org.settings.dev

Now you able to access the development site: http://localhost:8000

To run the project tests:

python manage.py test --settings=volontulo_org.settings.test_settings -v 3

You can run the tests locally using SQLite, which is faster:

python manage.py test --settings=volontulo_org.settings.test_settings_sqlite -v 3

Don't forget to run the tests on the production RDBMS (test_settings) before pushing your changes!

To populate database with 3 required badges (volunteer, participant, prominent-participant) run followin command:

python manage.py addbadges --settings=volontulo_org.settings.dev