Flare-dispatch NPM

Flare Dispatch

This is the frontend application used by flare dispatchers to run the operations.

It's built in React / Redux / Typescript and it includes some other libraries.

Prerequisites

It requires node v20 to run, please make sure to have the correct version installed.

You can check your node version with node --version.

Note: you can use nvm to easily install and manage multiple node versions.

Installation

Before installing the project, please make sure you have read the prerequisites.

Install the dependencies with yarn install
Run the project with yarn start

At this point you can navigate with your browser to https://localhost:8080 to see the application running in the browser.

Note: depending on the configuration, you might be redirected to the login form of the authentication provider.

You are now ready to develop :rocket:

How to develop

There are a number of rules that need to be followed to ensure keep the application structure is compliant with modern conding standards.

Before starting writing code, make sure you follow the coding guidelines.

For detailed instructions on what are the steps to follow when developing, please read the development steps page.

How to contribute

Everyone contributing to this project shall respect the contribution rules.

Security measures are applied to the repository so that it is protected from (some of) the bad practices.

For detailed instructions on how to contribute, please read the contribution rules page.

How to deploy

The app is configured to run in a docker image served by an embedded webserver; that makes it portable and convenient when has to run in a kuberneters environment.

For detailed instructions on the deployment process please read deploying to production.

For more about docker, please read the docker configuration page.

Configuration

All the dev tools are already pre-configured and everything should work out of the box.

For more details read configuring the tools.