We are developing a tool for humanitarians to manage project activities and indicator results across their programs, including approval workflows and reporting and visualizations. Our goal is to help organizations answer common questions such as:

• who are funding your projects?
• who you work with?
• where you work?
• how do my outputs align with my overall project goal?

Note: you should use python 3 for this project, meaning you may need to use python3 or pip3 in the following instructions (you can use the package manager on your OS, brew for mac, to install python 3).

Open up your terminal and follow the instructions listed below.

See these instructions for installing known dependencies.

Navigate to the folder you want the repository to be stored in.

Run the following command:

$ git clone --branch dev https://github.com/hikaya-io/Activity.git

Once cloned, navigate to the cloned repository with:

$ cd Activity

or similar.

$ pip install virtualenv

$ virtualenv --no-site-packages <myvirtualenvironmentname>

• use no site packages to prevent virtualenv from seeing your global packages
• . /bin/activate allows us to just use pip from the command-line by adding to the path rather then full path.

$ source <myvirtualenvironmentname>/bin/activate

$ pip install -r requirements.txt

Copy the example config:

$ cp activity/settings/local-sample.py activity/settings/local.py

Edit database settings activity/settings/local.py as shown below.

We will change the ENGINE parameter to the default value for postgres (although you can also user MySQL or Sqllite3 which is out-of-the-box supported by Django). We also need to add a default database name in the NAME option.

Since postgres is the preferred database for this project, we have provided extra instructions to help you set it up. These can be viewed here.

47 DATABASES:
48  'default': {
49    #'ENGINE': 'django.db.backends.postgresql', # Alternatives: 'postgresql', 'postgresql_psycopg2', 'mysql', 'sqlite3' or 'oracle'.
50    'ENGINE': "django.db.backends.postgresql"
51    'NAME': os.environ.get('ACTIVITY_CE_DB_NAME', 'mydatabasename'), # replace mydatabasename here with the name of your database
52    # The following can be left unchanged for local use:
53    'USER': os.environ.get('ACTIVITY_CE_DB_USER', ''),
54    'PASSWORD': os.environ.get('ACTIVITY_CE_DB_PASSWORD', ''),
55    'HOST': os.environ.get('ACTIVITY_CE_DB_HOST', ''),
56    'PORT': os.environ.get('ACTIVITY_CE_DB_PORT', ''),

$ python manage.py migrate

$ python manage.py createsuperuser

If you're using more then one settings file change manage.py to point to local or dev file first.

$ python manage.py runserver

This will run the server on http://127.0.0.1:8000 (Don't open the link in your browser yet). You can configure the host and port as needed.

Once you have created your user account, you need to create an activity user that is linked to this user account.

Go to http://127.0.0.1:8000/admin and sign in using your superuser account. Under the workflow model, you'll find activity user. Create a new activity user making sure you associate your user under the user attribute.

Before launching the dashboard on http://127.0.0.1:8000, you need to log out of the admin account first. This is to avoid an AttributeError.

Use the same admin credentials on the dashboard login page.

Ensure docker is installed on your local computer!

$ docker-compose build

$ docker-compose up 

you can add the -d flag to run the container in detached mode

$ docker-compose up -d --build

If docker is exiting due to postgres connection issues. Stop your local postgres instance, then rerun the above command

$ docker-compose exec web python manage.py createsuperuser

navigate to admin, login and create a activity_user

$ docker-compose exec web python manage.py [operation]

The operation in this case can be: makemigrations, migrate, collectstatic etc

1. GDAL

On mac:

$ brew install gdal

2. pango

On mac:

$ brew install pango

On mac:

$ brew update
$ brew install postgresql
$ initdb /usr/local/var/postgres
$ pg_ctl -D /usr/local/var/postgres start
$ createdb <mydatabasename>

pg_ctl -D /usr/local/var/postgres start # to start
pg_ctl -D /usr/local/var/postgres stop # to stop

If you get access denied, it means you need to modify the config file and write your Mysql username and password in the file

To fix any issues related to your path that may come up during the django set up, run:

$ export PATH=$PATH:/usr/local/mysql/bin

or specify the path you have to your installed mysql_config file in the bin folder of mysql

If you want this environment variable to be automatically set, please include it in your bash_profile or bashrc file.

Replace user and password by your Mysql username and password

CREATE DATABASE 'activity';
CREATE USER 'root';
GRANT ALL ON activity.* TO 'root'@'localhost' IDENTIFIED BY 'root';

NB: When you use these SQL queries, beware of not writing the quotes.