Life Events Platform

Welcome to the Life Events Platform, using the OGCIO building blocks. This repository contains the Live Events application and two Building Blocks: Messaging and Payments.

To read more about the project you can refer to the Documentation folder. You can start by reading the Introduction which contains the Setup to run this project locally.

In case you want a more interactive experience you can start our web-based documentation just by running: npm i && npm start:docs.

The docs application will start usually at http://localhost:3000. From there you can setup this repo and read all the technical docs

Bearer Integration

Bearer is integrated into our application's pipeline to enhance security and privacy by monitoring API usage and ensuring compliance with data protection regulations.

Pipeline Integration

Bearer has been added as a step in our CI/CD pipeline. This step performs the following tasks:

• Monitors API calls made by our application.
• Ensures compliance with data protection regulations.
• Fails the pipeline if any critical or high issues are found.

Running Bearer Reports Locally

To facilitate local development and testing, npm commands that allow you to run Bearer reports locally.

Prerequisites

Before running Bearer reports locally, ensure you have the following installed:

• Node.js (>=14.x)
• npm (>=6.x)
• Bearer CLI (follow the installation instructions)
• Docker

Running life events locally

Welcome fellow developer, in order to start the dev environment, after you have installed all the prerequisite software, the first thing needed is to run npm install to install all dependencies.

After that, you can run make start to start every app. This command will create and run all required docker containers

Note: Logto is required to use authentication, please refer to OGCIO Logto

After merging new changes from remote branches, you can run npm install to update dependencies. It's possible that new environment variables have been added, so you can run make update-env to update your .env files based on the latest .env.sample. Note: This script replaces the entire .env files. If you have custom entries, it might be better to update the files manually to avoid overwriting them.

NPM Commands

The following npm commands are available for running Bearer reports locally:

• Run Bearer Scan: This command runs the Bearer audit and generates an report bearer-scan-report.html.

  make security-scan

• Generate privacy report: This command generates an HTML privacy report bearer-privacy-report.html.

  make security-privacy-report