Developer Guide

The Developer Guide provides the necessary information for setting up, configuring, and running the Beneficiary Platform.

It includes:

  • Prerequisites – Software, system, and database requirements

  • Environment Variables – List of configuration variables required for the system

  • Database Schema Setup Covers creating and initializing the required database tables, extensions, and relationships for the Beneficiary backend.

  • Build and Run Steps – Steps to set up and run the platform locally or in a containerized environment

  • Keycloak and hasura setup – Provides steps to configure authentication, authorization, and GraphQL engine integration for the beneficiary backend.

  • Role and Access Control – Explains how user roles (beneficiary, admin) are registered in Keycloak and the database

Last updated