[go: up one dir, main page]

Skip to content

An open source volunteer management platform from the Federation of Humanitarian Technologists

License

Notifications You must be signed in to change notification settings

FederationOfTech/Coalesce

Repository files navigation

Coalesce

Build Status Built with

Coalesce is a 100% open-source volunteer management platform. Its mission is to make recruiting, onboarding, and managing volunteers as easy as possible. For volunteers, it is made to make finding tasks where you can contribute increadibly simple, allowing you to focus on contributing to the cause that means the most to you.

Coalesce is a Federation of Humanitarian Technologists member project. For more information on the work we do and how to work with us, please see our website.

Some features you can expect from Coalesce are:

  • 🔍 Easy browsing of existing volunteer opportunities
  • 📢 Register new events & recruit volunteers
  • ☑️ Check in volunteers at live events
  • 🧙‍♀️ Generate reports on volunteer activities

Prerequisites

Docker

  • Available on Mac or Windows
  • Windows client requires a specific version of Windows, WSL 2 Linux kernel and Git. Once up and running Docker can be found on the right of the tool bar. Run git config core.autocrlf false before checking out a git branch so that UNIX line-endings needed by containers are used.

Local Development

Coalesce is a web application which uses Django, Django Rest Framework, and Postgres on our backend.

For our front end code, we use Vue.js

To start the dev server for local development:

docker-compose up

Once everything is running, you should be able to see:

Run a command inside the api backend docker container:

docker-compose exec api [command]

For example, [command] can be /bin/bash and you get a shell to the running container.

Once you are in the container, you can then run the tests by doing:

./manage.py test

You can also start the django shell by doing:

./manage.py shell

To connect to the postgresql database, you can either do:

docker-compose exec postgres psql -U postgres

or connect to localhost on port 5432 using a local postgresql client.

Documentation

Check out the project's documentation.