A modern way for nonprofits to manage project activities and indicator results.
Try out Activity using our hosted version at hikaya.io.

This is the source code that runs the Activity application. If you want to use Activity then you don't need to run this code, we offer a hosted version of the app at activity.hikaya.app.

If you'd like to run your own copy of Activity or contribute to its development, then this is the place for you.

Getting started

Requirements and recommendations

• Git
• Docker and Docker Compose
• Python 3.7+, preferably inside a Python virtual environment (virtualenv, pipenv or others)

Recommended setup

For the sake of similarity between developers environments and the deployment environments, we strongly recommend using Docker Compose. For more details, see our installation guide.

Clone the repository and launch Activity and its PostgreSQL database using the following:

git clone --branch develop https://github.com/hikaya-io/activity.git && cd activity
docker-compose up

This will:

1. Pull needed Docker images
2. Launch PostgreSQL
3. Build and launch Activity
4. Run database migrations on the PostgreSQL instance

It may take a while, but Activity should be accessible at http://localhost:8080

This setup is using the environment variables defined in the file .env.docker-compose. You can read more about Activity's expected environments variables in our installation guide.

Post-installation

1. Apply the Django fixtures defined in the fixtures folder:

docker-compose exec app python manage.py loaddata fixtures/auth_groups.json  # Add authorization groups
docker-compose exec app python manage.py loaddata fixtures/countries.json  # Add countries
docker-compose exec app python manage.py loaddata fixtures/sectors.json  # Add sectors

2. Create a Django superuser/admin: docker-compose exec app python manage.py createsuperuser. You can now use it to login at http://localhost:8000/admin
3. Signup with a new user on Activity. Activate it through Django Admin Dashboard on http://localhost:8000/admin/workflow/activityuser/

Contributing

Activity is built and maintained by the team at Hikaya.

Feel free to checkout and learn more about:

• Our contribution guide
• Our development process

We are always looking for a fresh set of :eyes: who want to contribute to Activity, so if you are interested, you can reach out in our issues board or open a Github discussion and we'll help you get started!