Evelyn Management UI

Overview

In this section we’ll describe how to get the code for the Evelyn Management UI, and build and run it.

Note that there’s not much point in doing this unless you have already set up an Evelyn server. So, if you haven’t done this yet, head over to https://evelyn.readthedocs.io/en/latest/ and return here when you’re done.

Getting the code

The Evelyn Management UI repository is hosted on Github. You can clone the repo with one of the following commands:

Using HTTPS

git clone https://github.com/binarymash/evelyn-management-ui.git

Using SSH

git clone git@github.com:binarymash/evelyn-management-ui.git

Running the management UI

Prerequisites

Configuring

If you are running the default configuration of the sample Evelyn REST API server then you shouldn’t have to make any changes to the management UI configuration. Otherwise, you might need to change where the management UI is trying to access the REST API server - this is currently hard-coded in ./src/api.js.

Running

  • install the package dependencies required by the application - npm install
  • run the application - npm start

The development server will start and open up a browser window with the management UI:

_images/dashboard-default.png

Introduction

Evelyn is a feature toggling framework. It allows users to decouple software releases from the functional changes within, reducing the risk of deployment and providing rollback functionality.

The Evelyn Stack consists of the following parts:

  • A core framework providing the underlying feature toggling functionality, written in C# and targetting .NET Standard 2.0
  • A REST API server and client that expose this functionality over HTTP, written in C# and targetting .NET Standard 2.0. Sample hosts are provided for .NET Core 2.1.
  • A management user interface, built on React/Redux/Node.

Evelyn has a modular architecture which allows for flexible deployment configurations and user extensibility. The core framework is built around CQRS and Event Sourcing: implementations are provided for an in-memory event store and for Greg Young’s Event Store; you can plug in your own event store integration.

This project is pre-release: things might break at any moment; APIs might change; it is insecure.

This documentation

This documentation is for the management UI.

For more information on the core framework and the REST API server and client head over to https://evelyn-management-ui.readthedocs.io/en/latest/.