Skip to content

equinor/flotilla

Repository files navigation

Flotilla

Backend Frontend Codacy Badge

Flotilla is the main point of access for operators to interact with multiple robots in multiple facilities.
The application consists of a frontend in React, a backend in ASP.NET and a Mosquitto MQTT Broker.

Deployments

We currently have 3 environment (Development, Staging and Production) deployed to Aurora.

Environment Deployment Status
Development Frontend
Backend
Dev
Staging Frontend
Backend
Staging
Production Frontend
Backend
Production

Setup

For development, please fork the repository. Then, clone the repository:

git clone https://github.com/equinor/flotilla

Please see separate installation guides for frontend, backend, and Broker. For the environment setup, either run the script as described below or do it manually as described in each component.

Automatic environment setup

Run the setup.sh to automatically set up your dev environment for the components. This script will ask you for the Client Secret for the backend and the MQTT broker server key for the MQTT broker.

Run with docker

Install docker and docker compose.

Build the docker container:

docker compose build

Setup a .env file in the backend directory with the following environment variables:

AZURE_CLIENT_ID
AZURE_TENANT_ID
AZURE_CLIENT_SECRET

Start Flotilla by running:

docker compose up

or

docker compose up --build

Contributions

Equinor welcomes all kinds of contributions, including code, bug reports, issues, feature requests, and documentation. Please initiate your contribution by creating an issue or by forking the project and making a pull requests. Commit messages shall be written according to this guide.