,,\\\\\\,,
  ,\\\\\\\\\\\
 ▲▲▲▲▲▲\\\\\\\\  FIX THE STATUS QUO
▲▲▲▲▲▲▲▲\\\\\\`  PROCA SERVER v3
▼▼▼▼▼▼▼▼\\\\\`
 ▼▼▼▼▼▼\\\^``    https://proca.app

Proca Server is an Elixir application that uses PostgreSQL as a datastore and RabbitMQ for asynchronous data processing. It serves as the backend for the Proca Widget, providing campaign infrastructure for NGO and non-profit movements.

This is a (mostly headless) Phoenix Framework app, built using standard Phoenix practices. If you're new to Phoenix, we recommend reading up on its conventions to contribute effectively — see the development guide and deployment guide.

Made with ❤️, Elixir, and the belief that we can build tools to make the world a better place.

This project is released under a Contributor Code of Conduct. By participating, you agree to uphold its principles.

• Headless architecture – Built to serve apps via APIs.
• GraphQL API – Flexible and efficient data querying.
• Fine-grained permission system – Users are organized into Organizations (Orgs) with specific roles and access scopes.
• Authentication – Supports HTTP Basic Auth or JWT tokens (ideal for external identity providers).
• Campaign tree model – Organizes action pages into campaigns; multiple orgs can collaborate in coalitions.
• End-to-end encrypted data – Member personal data is stored encrypted at rest. Only the controlling Org can decrypt it.
• Schema-based personal data validation – Supports various formats.
• GDPR compliance – Includes consent management, optional double opt-in, and action staging (moderation/filtering before acceptance).
• Email delivery – Sends thank-you, opt-in, and email-to-target messages via Mailjet, AWS SES, and more.
• Pluggable processing – Asynchronous action processing via RabbitMQ.
• Flexible forwarding – Pushes actions to AWS SQS or CRMs via a decryption gateway deployed by the Org.
• CSV export – Action data can be exported in spreadsheet-friendly format.

To develop and run the Proca server, you’ll need:

• PostgreSQL
• RabbitMQ
• asdf
• Node.js

We recommend using asdf to install Erlang and Elixir. Other installation methods may lead to version conflicts you'll need to resolve manually.

• Our asdf setup guide for Ubuntu
• Script for RabbitMQ installation on Ubuntu

1. Clone your fork of the repo.

2. Run the following setup commands:

sudo apt install automake libssl-dev autoconf libncurses5-dev
asdf plugin add erlang
asdf plugin add elixir
asdf install
mix local.rebar
mix local.hex

1. Ensure PostgreSQL and RabbitMQ are installed and running.

2. Set the environment variables:

export MIX_ENV=dev
export ADMIN_EMAIL=your_admin_email@example.com

3. Run the configuration script:

./utils/configure-development-env.sh

This script:

• Sets up PostgreSQL
• Installs Erlang, Elixir, Phoenix and RabbitMQ dependencies
• Runs npm install inside the assets/ directory

You'll be prompted for sudo during parts that configure PostgreSQL.

You'll be prompted for setting the ADMIN_EMAIL variable if you failed on reading this manual. The script will print out your login and password:

#####
#####   Created Admin user your_admin_email@example.com  #####
#####   Password: VERY_RANDOM_PASSWORD
#####

mix phx.server

By default, the development webserver is located at: http://localhost:4000/

To build:

./build

Read more in Developing.

You can use the following environment variables to customize server behavior during development:

• ENABLE_TELEMETRY If set to true, the server will expose Prometheus metrics on port 9568. Disabled by default in development.

• START_DAEMON_SERVERS If set to true, the server will start background processes. Disable this to speed up development server startup (e.g., if you're not working on MTT). Enabled by default, disable with:

export START_DAEMON_SERVERS=false