Skip to content

martin-flower/operatorfabric-core

 
 

Repository files navigation

OperatorFabric README

MPL-2.0 License Build Status Quality Gate Coverage Code Smells Website opfab.github.io Join us on Spectrum

1. Introduction

OperatorFabric is a modular, extensible, industrial-strength and field-tested platform for use in electricity, water, and other utility operations.

  • System visualization and console integration

  • Precise alerting

  • Workflow scheduling

  • Historian

  • Scripting (ex: Python, JavaScript)

Note
Workflow Scheduling could be addressed either as an internal module or through simplified and standardized (BPMN) integration with external workflow engines, we’re still weighing the pros and cons of the two options._

OperatorFabric is part of the LF Energy coalition, a project of The Linux Foundation that supports open source innovation projects within the energy and electricity sectors.

OpFab is an open source platform licensed under Mozilla Public License V2. The source code is hosted on GitHub in this repository : operatorfabric-core.

UI screenshot

2. Try it!

If you want to try OperatorFabric (see what the UI looks like with some test cards) in a few minutes, follow the steps below.

  1. Clone this repository

    git clone https://github.com/opfab/operatorfabric-core.git
    cd operatorfabric-core
  2. Launch our demo docker-compose file

    ./config/docker/docker-compose.sh
  3. After a little while, log into the application UI at localhost:2002/ui/ using admin/test as credentials.

    Warning
    Don’t forget the final slash in the URL or you will get an error.
  4. Push cards using the following test script

    ./services/core/cards-publication/src/main/bin/push_card_loop.sh --publisher TEST --process process
Tip
If you want to experiment in more depth and have more details on how it works (as well as some troubleshooting), check out our Getting Started guide!

3. Technology stack

3.1. Development

OperatorFabric is mostly written in Java and based on the Spring framework. This makes writing and integrating software for a simplified and better coordination very easy.

Using Java Using Spring Using Angular Using Swagger

3.2. Continuous Integration / Continuous Delivery

OperatorFabric is built and integrated using battle-tested tools and (open) platforms.

Built with Gradle Using Travis CI Using SonarCloud

4. Licensing

This project and all its sub-projects are licensed under Mozilla Public License V2.0. See LICENSE.txt

5. Contributing

Read our Community Documentation for more information on how to contribute to the project.

About

Main operatorfabric program

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 34.3%
  • TypeScript 28.2%
  • Handlebars 15.0%
  • Gherkin 9.0%
  • HTML 8.2%
  • JavaScript 2.0%
  • Other 3.3%