From 3db8c5658638bd36f3aadbfe64c0763e7ee3d2ae Mon Sep 17 00:00:00 2001 From: Uladzislau Arlouski Date: Fri, 7 Aug 2020 18:27:24 +0300 Subject: [PATCH 1/2] Add extension development guide --- README.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 58 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 138c23ce..d08d5c54 100644 --- a/README.md +++ b/README.md @@ -1 +1,58 @@ -# [WIP] Vividus extension for Visual Studio Code \ No newline at end of file +# Development guide + +## Tools +* Node JS v12.13.0 or higher +* Open JDK 12.0.1 or higher +* Eclipse IDE 2019-09 R (4.13.0) or higher +* Visual Studio Code 1.47.1 or higher + +## General +1. Run `git clone https://github.com/vividus-framework/vividus-studio.git` +2. Run `npm install -g yo generator-code` +5. Install `Eclipse PDE (Plug-in Development Environment)` plugin in Eclipse IDE through `Eclipse Marketplace` + +## Import project to Eclipse +### Import plugin +1. Open `Eclipse IDE` +2. Go to `File` tab in main menu and select `Import...` +4. Select `Plug-ins and fragments` under `Plug-in development` section +5. Set import directory to `/vividus-studio/vividus-studio-server` under `Import From` section +6. Select `Select from all plug-ins and fragments found at the specified location` under `Plug-ins and Fragments to Import` section +7. Select `Projects with source folders` under `Import As` section +8. Click `Add all ->` and then `Finish` buttons +9. Add the follwing entries into `/vividus-studio/vividus-studio-server/vividus-studio-plugin/.classpath` XML file under `` section and then refresh the project +``` + + + + + + + + + + +``` + +### Import target platform +1. Open `Eclipse IDE` +2. Go to `File` tab in main menu and select `Import...` +4. Select `Existing Project into Workspace` under `General` section +5. Set root directory to `/vividus-studio/vividus-studio-server/vividus-studio-target-definition` under `Select root directory` section +6. Click `Finish` +7. Nevigate to `Eclipse -> Preferences... -> Plug-in Development -> Target Platform` +8. Select `Vividus Studio Target Definition` +9. Click `Apply and Close` + +## Build server +1. Go to `/vividus-studio/vividus-studio-server` +2. Run `./mwnw clean install` + +## Use extension +1. Run `git clone --recursive https://github.com/vividus-framework/vividus-starter.git` +2. Run `cd vividus-starter && unset BUILD_SYSTEM_ROOT && ./gradlew runStories` +3. Nevigate to `/vividus-studio` +4. Run `code .` +5. Press `F5` to start extension +6. After project window is open click `File -> Open...` +7. In the opened window open `vividus-starter` project cloned previously From 0a1faf7388d6d9ab29bc2cfc0b38269492cea20f Mon Sep 17 00:00:00 2001 From: Valery Yatsynovich Date: Wed, 28 Jun 2023 18:33:13 +0300 Subject: [PATCH 2/2] Add improvements --- README.md | 78 +++++++++++++++++++++++++++---------------------------- 1 file changed, 39 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index d08d5c54..d04b7120 100644 --- a/README.md +++ b/README.md @@ -1,58 +1,58 @@ # Development guide ## Tools -* Node JS v12.13.0 or higher -* Open JDK 12.0.1 or higher -* Eclipse IDE 2019-09 R (4.13.0) or higher -* Visual Studio Code 1.47.1 or higher +* Node.js 18 or higher +* JDK 17 or higher +* Eclipse IDE 2023-06 (4.28.0) or higher +* Visual Studio Code 1.79.1 or higher ## General 1. Run `git clone https://github.com/vividus-framework/vividus-studio.git` -2. Run `npm install -g yo generator-code` -5. Install `Eclipse PDE (Plug-in Development Environment)` plugin in Eclipse IDE through `Eclipse Marketplace` +1. Run `npm install -g yo generator-code` +1. Install `Eclipse PDE (Plug-in Development Environment)` plugin for Eclipse IDE through `Eclipse Marketplace` ## Import project to Eclipse ### Import plugin 1. Open `Eclipse IDE` -2. Go to `File` tab in main menu and select `Import...` -4. Select `Plug-ins and fragments` under `Plug-in development` section -5. Set import directory to `/vividus-studio/vividus-studio-server` under `Import From` section -6. Select `Select from all plug-ins and fragments found at the specified location` under `Plug-ins and Fragments to Import` section -7. Select `Projects with source folders` under `Import As` section -8. Click `Add all ->` and then `Finish` buttons -9. Add the follwing entries into `/vividus-studio/vividus-studio-server/vividus-studio-plugin/.classpath` XML file under `` section and then refresh the project -``` - - - - - - - - - - -``` +1. Go to `File` tab in main menu and select `Import...` +1. Select `Plug-ins and fragments` under `Plug-in development` section +1. Set import directory to `/vividus-studio/vividus-studio-server` under `Import From` section +1. Select `Select from all plug-ins and fragments found at the specified location` under `Plug-ins and Fragments to Import` section +1. Select `Projects with source folders` under `Import As` section +1. Click `Add all ->` and then `Finish` buttons +1. Add the follwing entries into `/vividus-studio/vividus-studio-server/vividus-studio-plugin/.classpath` XML file under `` section and then refresh the project + ```xml + + + + + + + + + + + ``` ### Import target platform 1. Open `Eclipse IDE` -2. Go to `File` tab in main menu and select `Import...` -4. Select `Existing Project into Workspace` under `General` section -5. Set root directory to `/vividus-studio/vividus-studio-server/vividus-studio-target-definition` under `Select root directory` section -6. Click `Finish` -7. Nevigate to `Eclipse -> Preferences... -> Plug-in Development -> Target Platform` -8. Select `Vividus Studio Target Definition` -9. Click `Apply and Close` +1. Go to `File` tab in main menu and select `Import...` +1. Select `Existing Project into Workspace` under `General` section +1. Set root directory to `/vividus-studio/vividus-studio-server/vividus-studio-target-definition` under `Select root directory` section +1. Click `Finish` +1. Nevigate to `Eclipse -> Preferences... -> Plug-in Development -> Target Platform` +1. Select `Vividus Studio Target Definition` +1. Click `Apply and Close` ## Build server 1. Go to `/vividus-studio/vividus-studio-server` -2. Run `./mwnw clean install` +1. Run `./mwnw clean install` ## Use extension 1. Run `git clone --recursive https://github.com/vividus-framework/vividus-starter.git` -2. Run `cd vividus-starter && unset BUILD_SYSTEM_ROOT && ./gradlew runStories` -3. Nevigate to `/vividus-studio` -4. Run `code .` -5. Press `F5` to start extension -6. After project window is open click `File -> Open...` -7. In the opened window open `vividus-starter` project cloned previously +1. Run `cd vividus-starter && unset BUILD_SYSTEM_ROOT && ./gradlew runStories` +1. Nevigate to `/vividus-studio` +1. Run `code .` +1. Press `F5` to start extension +1. After project window is open click `File -> Open...` +1. In the opened window open `vividus-starter` project cloned previously