TURNEditor

Overview

TURN Editor is a collaborative editor for URN (User Requirements Notation. Currently, it supports TGRL (Textual Goal-oriented Requirement Language) which is a part of TURN. The overall goal is to build a collaborative editor for the complete URN, including its scenario/workflow notation Use Case Maps and support for the analysis of goal and scenario/workflow models. TURNEditor uses tColab framework which is based on the architecture of Eclipse Che and Theia. It has three parts - Backend (TURN Grammar Language Server and Sprotty Language Server Extension), Frontend (TURNEditor and Sprotty View), and Configuration (Docker Image and other configurations required to launch TGRL Theia extension in Eclipse Che to make it collaborative).

Prerequisites

Building TURNEditor for Browser

• Node.js
• Yarn
• Gradle

Launching TURNEditor in Eclipse Che

• Docker CE
• Eclipse Che

Launch TURNEditor locally in Browser

git clone --recursive https://github.com/JUCMNAV/TURNEditor.git

Open Terminal and navigate to TURNEditor folder

cd Frontend
yarn
cd turn-app
yarn start

Open browser and use http://localhost:3000/ to launch TURNEditor

Launch TURNEditor in development mode

For development it is better to connect to the running LSP through a socket. Import project org.xtext.project.turn.tcolab.parent in Eclipse or in other IDE as an "Existing gradle project".

• Select projects and go to project -> clean
• Go to org.xtext.project.turn.tcolab.diagram -> src -> main -> xtend-gen -> org.xtext.project.turn.tcolab.diagram -> RunSocketServer
• Run As -> Java Application

Open Terminal and navigate to Frontend folder inside TURNEditor

cd turn-app
yarn run start:backend:socket

Open browser and use http://localhost:3000/ to launch TURNEditor in browser connected to the running LSP through a socket.