equinor / fmu-editor

5 stars 2 forks source link

⚠️ Please note that this is a beta version.

FMU Editor


FMU Editor

An integrated development environment for FMU users.

## Table of Contents - [Introduction](#introduction) - [Features](#features) - [Feedback](#feedback) - [Build Process](#build-process) ## Introduction ![GitHub](https://img.shields.io/github/license/equinor/fmu-editor) [![Total alerts](https://img.shields.io/lgtm/alerts/g/equinor/fmu-editor.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/equinor/fmu-editor/alerts/) [![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/equinor/fmu-editor.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/equinor/fmu-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/fmu-editor) Enhance your work with FMU by using this integrated development environment. Benefit from its schema validation, supportive editor environment and its source control capabilities. Available via Komodo.

## Features - Integrated file explorer - Editor for editing FMU configuration files - Connected to Komodo for automatic JSON schema support - Preview of config files - Integrated file version control system - Pull, push and log changes - Resolve conflicts - View other users' changes - Changelog explorer for comparing file changes ## Feedback Feel free to send us feedback in the 💬 [discussions forum](https://github.com/equinor/fmu-editor/discussions) or ❗[file an issue](https://github.com/equinor/fmu-editor/issues). Feature requests are always welcome 😊👍. If you'd like to contribute, please take a look at our 📜 [guidelines](https://github.com/equinor/fmu-editor/blob/master/doc/CONTRIBUTE.md). ## Build Process 1. Install Node.js >= 18.13.0 (https://nodejs.org/en/ or for Node Version Manager https://github.com/nvm-sh/nvm). 2. Clone the repository: ```bash git clone git@github.com:equinor/fmu-editor.git ``` 3. Install dependencies: ```bash npm install ``` 4. Start electron app in developer mode: ```bash npm run electron:dev ``` 5. In order to test the production-ready app, run: ```bash npm run electron:build ```