https://github.com/equinor/webviz-config-editor

Web based GUI editor for configurating webviz YAML files.
https://github.com/equinor/webviz-config-editor

editor webviz yaml

Last synced: about 2 months ago
JSON representation

Web based GUI editor for configurating webviz YAML files.

• Host: GitHub
• URL: https://github.com/equinor/webviz-config-editor
• Owner: equinor
• License: mit
• Created: 2021-09-28T11:19:43.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-04-25T04:26:57.000Z (over 1 year ago)
• Last Synced: 2023-05-05T10:39:33.275Z (over 1 year ago)
• Topics: editor, webviz, yaml
• Language: TypeScript
• Homepage: https://github.com/orgs/equinor/projects/24
• Size: 6.05 MB
• Stars: 3
• Watchers: 4
• Forks: 4
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
> ⚠️ Please note that this is a beta version.

 Webviz Config Editor 
 




  

    

  





  An open-source editor for creating Webviz dashboards.





  

  

    Checkout Main Project

  

  ·

  📦 

  

    Download Binaries

  



## Table of Contents

-   [Introduction](#introduction)

-   [Features](#features)

-   [Feedback](#feedback)

-   [Build Process](#build-process)

## Introduction

![GitHub](https://img.shields.io/github/license/equinor/webviz-config-editor)

[![Build Status](https://github.com/equinor/webviz-config-editor/workflows/wce-publish/badge.svg)](https://github.com/equinor/webviz-config-editor/actions?query=branch%3Amain)

[![Total alerts](https://img.shields.io/lgtm/alerts/g/equinor/webviz-config-editor.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/equinor/webviz-config-editor/alerts/)

[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/equinor/webviz-config-editor.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/equinor/webviz-config-editor/context:javascript)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier%20%28JavaScript%29-ff69b4.svg)](https://github.com/prettier/prettier)

![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/equinor/webviz-config-editor)

Enhance your work with Webviz config files with file validation, autocompletion, live preview and an integrated build and play environment. All in one simple and lightweight app. Built with React, Electron, Monaco Editor and Redux.

Available for both Linux and Windows.



  



## Features

A few of the features of Webviz Config Editor:

-   Edit and preview Webviz config files

-   Autocompletion and file format validation

-   Select content in live-preview to quickly find its corresponding lines in the editor

-   Build and view your final Webviz dashboard

-   Select your preferred Python interpreter and Webviz theme

## Feedback

Feel free to send us feedback in the 💬 [discussions forum](https://github.com/equinor/webviz-config-editor/discussions) or ❗[file an issue](https://github.com/equinor/webviz-config-editor/issues).

Feature requests are always welcome 😊👍. If you wish to contribute, please take a look at our 📜 [guidelines](https://github.com/equinor/webviz-config-editor/blob/master/CONTRIBUTING.md).

## Build Process

1. Install Node.js (https://nodejs.org/en/ or for Node Version Manager https://github.com/nvm-sh/nvm).

2. Install dependencies:

    ```bash

    npm install

    ```

3. Start electron app in developer mode:

    ```bash

    npm run electron:dev

    ```

4. In order to test the production-ready app, run:

    ```bash

    npm run electron:build

    ```