Flumer

A lightweight, highly extendable logger for both client and server JS applications

Packages

@flumer/core

@flumer/logger

Development

Getting Started

Clone this repository and from the root run:

yarn

Running Tests

From the repository root, run:

yarn test

Development Sandboxes

Sandbox environments are provided by this repo for code examples and testing during development.

Node Sandbox

The NodeJS Sandbox provides an environment for testing Flumer in a Node environment. To run the sandbox from the repository root:

yarn sandbox:node

Web Sandbox

The Web Sandbox provides an environment for testing Flumer in a Web environment. To run the sandbox from the repository root:

yarn sandbox:web

Running Static Analysis (ESLint)

From the repository root, run:

yarn run check

Compiling Packages

From the repository root, run:

yarn compile

Conventional Commits

To commit changes, run:

yarn commit

This will run the Commitizen wizard to enforce conventional commit standards.

Packages Releases

Flumer packages are published to NPM using Semantic Release. Specifically, we use the Lerna Semantic Release Changelog to facilitate the monorepo codebase format.

The publishing happens in our CI/CD process using Github Actions from within the release build stage that only runs when changes are merged into the master branch.