holi-meta

The meta repository which helps you check out the other repositories and run a development environment locally.

• holi-meta
  • Getting started
    • Requirements
      • direnv && nodenv/nvm
      • Yarn
      • Ory
      • Emulator
      • Google Pub/Sub Emulator
      • OwnCloud Infinite Storage (OCIS)
      • Jitsi Meet
      • Docker-Compose
      • Deno
      • brew
    • Initialization
    • IDE setup
  • Running dev environments via mprocs
    • Local backend on Android
  • Helper scripts
    • forall-git
  • Port registry
  • Terraform authentication (optional)

Getting started

Requirements

direnv && nodenv/nvm

Before we can get started building, please ensure that both direnv and one of the following node version managers are installed and properly set up on your system (if in doubt, use nodenv):

• nodenv or
• nvm

Follow the instructions in the corresponding READMEs for setup.

.node-version (used by nodenv) ensures that all developers are using the same node/npm versions. It is kept in sync with .nvmrc (used by nvm) by a symbolic link, so please make sure to use a format that is understood by both tools (e.g. a fixed version).

Once you installed these tools, please leave and re-enter the project directory. direnv will ask you for permission to execute:

direnv: error /home/exampleuser/holi-meta/.envrc is blocked. Run `direnv allow` to approve its content

Run direnv allow to load the environment for the holi-meta project. This will install your first node environment. Afterwards, which npm should point to a node environment managed by either nodenv or nvm.

Yarn

Install yarn using npm install --global yarn and add yarn commands to you path by commenting out the line export PATH="$PATH:$(yarn global bin)" in your .envrc.local for being able to run mprocs later.

Ory

We're using Ory for authentication. For local development, we need a proxy. You can install the proxy via https://www.ory.sh/docs/guides/cli/installation.

Emulator

For installing the Android Emulator needed for running the mobile dev environment, please read the readme in holi-frontends.

Google Pub/Sub Emulator

To develop and test our event-driven applications locally, we use the Google Pub/Sub emulator, which provides local emulation of the Google Cloud Pub/Sub production service.

Please make sure you installed and are authenticated with gcloud CLI. Later steps will then ensure correct installation of the emulator.

Please note that all topics, subscriptions, and messages published to the emulator are only maintained for the lifetime of the emulator session.

Currently, okuna stands as the sole publisher of Google Pub/Sub. Similarly, holi-ocis-integration, which is referred to as ocis-subscriber in mprocs-local-backend.yaml, is the only subscriber of this service. This means that okuna is responsible for pushing messages to the Pub/Sub topic, and ocis-subscriber is the only client that receives and consumes those messages.

To obtain further information on the holi-ocis-integration project, please refer to the accompanying README.md.

OwnCloud Infinite Storage (OCIS)

To run OCIS locally there are additional steps required, please read the readme in holi-ocis.

Jitsi Meet

To run jitsi locally there are additional steps required, please read the readme in holi-meet.

Docker-Compose

Some projects (e.g. okuna) are using Docker or Docker-Compose to run their dev environment. Please install Docker-Compose.

Deno

Some projects are using deno. Install it and follow the instructions to add it to your environment.

brew

Some tools are installed via brew. Please follow the instructions for installing it (on MacOS AND also on Linux).

Make sure to integrate the brew shell-hook before nodenv,nvm and pyenv to avoid brew installed versions to take precedence.

Initialization

Once you have installed all prerequisites (or after anything changed in the setup), you can execute

./init.sh

and the script will set up everything for you.

If you also want to work on any optional, private repositories, then please execute

./init.sh full

for doing a full checkout.

IDE setup

Now you can open the projects in your favourite IDE. It's up to you whether you open the holi-meta folder or the checked out project subfolders in several IDEs .

Running dev environments via mprocs

In this repository, there are mprocs*.yaml files. Each one creates a unique dev environment by starting multiple cli processes. The default one, mprocs.yaml, can be started by just executing mprocs. It starts up everything you need for frontend development, connecting to APIs in the cloud based staging environments. When mprocs is running, you can simply switch panes using Ctrl+a.

If you need to work on APIs as well, you can execute different mprocs configurations. For example, in order to work on the okuna backend, run mprocs -c mprocs-local-backend.yaml instead, which will spin up Oathkeeper, the unified API and Okuna locally next to the frontends.

Local backend on Android

For Android you have to explicitly forward the port for the locally running backend, e.g. using

adb reverse tcp:4455 tcp:4455

Helper scripts

This repository includes some nice helper scripts to help with working with holi-meta. These are added to the path via direnv.

forall-git

This script executes git commands in this repository as well as in any git repository that is inside this repository (e.g. holi-frontends, holi-okuna, holi-unified-api etc.). For example, you can pull/update all repositories at once using:

forall-git git status # inspect if there is any changes left in any repository, and if not
forall-git git checkout main # switch to the main branch in all repositories
forall-git git pull # pull all repositories

Port registry

The following table lists all ports that are used for local execution.

Terraform authentication (optional)

All projects checked out below holi-meta are set up to authenticate to terraform/google via a keyfile that is expected to be found in holi-meta/.holi-terraform.key. If you need to run terraform locally, please ask any oldie to provide you with the necessary key file.