Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rrcomtech authored Feb 28, 2022
1 parent e64d78a commit ceef709
Showing 1 changed file with 13 additions and 63 deletions.
76 changes: 13 additions & 63 deletions editor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,85 +5,35 @@ for putting up the IDE (with Theia) and add visual support (with Sprotty).
## Software Versions
The following versions were used while developing this solution.
```
node 11.15.0
npm 7.16.0
yarn 1.22.5
nvm 0.35.1
node 12.22.5
npm 7.16.0 (and newer)
yarn 1.22.5 (and newer)
nvm 0.35.1 (and newer)
```

## Getting started

Install [nvm](https://github.com/creationix/nvm#install-script).
Install [nvm](https://github.com/creationix/nvm#install-script). E.g., write:

curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.5/install.sh | bash

Install npm and node.

nvm install 11.15.0
nvm use 11.15.0
nvm install 12.22.5
nvm use 12.22.5

Install yarn.

npm install -g yarn

## Quickstart
To run the software, simply execute
```shell
bash ./build_and_run_theia.sh
```
The shell file uses the commands below.

### Adding a custom language server
For using a language, Theia needs a language server file, it can start (typically a .jar file). The file `àssemble_custommade.sh` is
responsible for copying a freshly compiled language server to Theia. To do so, **have a look in the file and
configure its variables**. Afterwards, one can run:
```shell
bash ./assemble_custommade.sh
```
The language server, which is used for development is referenced [in this repository](https://github.com/rrcomtech/Visualization_of_DSL_Families).

## Running the browser example

yarn rebuild:browser
cd browser-app
yarn start

Open http://localhost:3001 in the browser.

## Running the Electron example

yarn rebuild:electron
cd electron-app
yarn start

## Developing with the browser example

Start watching of mdr-dsl.

cd mdr-dsl
yarn watch

Start watching of the browser example.

yarn rebuild:browser
cd browser-app
yarn watch

Launch `Start Browser Backend` configuration from VS code.

Open http://localhost:3000 in the browser.

## Developing with the Electron example
Install the VSCode dependencies. See [VSCode Prequisites](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites).

Start watching of mdr-dsl.
## Running the Editor

cd mdr-dsl
yarn watch
From the root directory, compile the plugins:

Start watching of the electron example.
yarn --cwd plugins/dsl-extension

yarn rebuild:electron
cd electron-app
yarn watch
Then, compile the editor and run it on port 3001:

Launch `Start Electron Backend` configuration from VS code.
yarn && yarn start --port 3001

0 comments on commit ceef709

Please sign in to comment.