FLEX (Federated Logic and Events eXchange System)

Monorepo for the business layer known as FLEX internally

Installation

1. Prerequisites

1. Node.js: Recommended install via nvm
2. pre-commit: brew install pre-commit
3. PNPM: install

2. Installation

Run the following make command to install dependencies and setup pre-commit:

pnpm install --frozen-lockfile
pre-commit install

Useful commands to use

To see a list of available commands you can check package.json scripts here are a few useful commands below:

pnpm test:affected
pnpm build:affected
pnpm lint:affected
pnpm format:check

Repo Overview

flex/
├── libs/        # Shared libraries directory
│   └── utils/   # Shared utils for modules to use
└── domains/     # Domains directory (application code)

Repo	Overview	README
@domains	Domains - application code	Link
@libs/utils	Shared utils to be used across modules	Link

Committing work

When wanting to commit changes please first squash your commits.

Simple command line procedure

Get the current number of commits on your branch:

git rev-list --count HEAD ^main

Supposing this returns 3 then you have made 3 commits since creating your branch and you want to squash them down into one:

git rebase -i HEAD~3

Which will launch an interactive rebase session in the terminal.