openvalidation/openvalidation-ide-ui repository overview

⁠openVALIDATION-IDE

⁠

Demo IDE⁠ | Documentation⁠

integrated development environment for openVALIDATION ⁠

⁠ ⁠

⁠contents

• introduction⁠
• architecture overview⁠
• run with docker⁠
• run local⁠
  • prerequisites⁠
  • commands⁠
  • environmental variables⁠

⁠introduction

openVALIDATION-IDE is a web-based development environment for users who are not familiar with coding. It enables Domain Experts, Business Analysts or Requirement Engineers to write complex validation rules themselves using natural language. These validation rules will be translated into code using openVALIDATION⁠.

Usually, an IDE is a very technical tool for coding. The openVALIDATION-IDE is an approach to hide all the technical features of an IDE and gives the user just the necessary tools for writing validation rules. It includes features like syntax highlighting, auto-completion and linting while making it look like a simple text-editor.

The major components of the tech stack for the openVALIDATION-IDE consists of the Angular framework⁠ and the Monaco Editor⁠ for its UI, while backend functionality is powered by Spring Boot⁠.

⁠architecture overview

The following overview describes the technology used as well as the way the components communicate with each other.

⁠run with docker

You can easily run the openVALIDATION-IDE on your local machine with docker, following these steps:

1. Install docker⁠ if not already installed
2. Clone this repository with git clone https://github.com/openvalidation/openvalidation-ide
3. Navigate into the previously cloned repository with cd openvalidation-ide
4. Run docker-compose up
5. Open localhost⁠ in your browser

If you don't want to download and compile the sources however, you can also just pull the latest images directly from dockerhub using this alternative docker-compose file⁠:

1. Install docker⁠ if not already installed
2. Download openvalidation-ide-dockerhub.yml⁠ to your machine
3. Run docker-compose -f openvalidation-ide-dockerhub.yml up
4. Open localhost⁠ in your browser

⁠run local

⁠prerequisites

To run the project locally, the following tools must be installed:

• Required installations for the frontend:
  1. Install a supported version of node.js⁠ if not already installed
  2. Install Angular CLI⁠ tool using npm package manager:

     npm install -g @angular/cli
     

     Copy
• Required installations for the backend:
  1. Install Java SE Development Kit 8⁠
  2. Download⁠ and install⁠ Apache Maven
• Install and run the openVALIDATION Language Server⁠

⁠commands

1. Clone this repository with git clone https://github.com/openvalidation/openvalidation-ide
2. Navigate into the previously cloned repository with cd openvalidation-ide
3. Run the frontend:
   1. Navigate into frontend directory with cd ./frontend/
   2. Install node dependencies:

      npm install
      

      Copy
   3. Start local angular frontend:

      ng serve
      

      Copy
4. Run the backend:
   1. Navigate into backend directory with cd ./backend/
   2. Start backend with in-memory h2 database

      mvn clean spring-boot:run -Dspring-boot.run.arguments=--cors-headers=http://localhost:4200
      

      Copy
5. Open localhost⁠ with your local angular port (default: 4200) in your browser

⁠environmental variables

These can be set in the docker-compose file or when the container is started.

⁠frontend

⁠backend