Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add extension development guide #14

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add extension development guide #14

wants to merge 2 commits into from

Conversation

uarlouski
Copy link
Member

No description provided.

README.md Outdated
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 `<path-to-repo>/vividus-studio`

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nevigate -> Navigate

README.md Outdated
## General
1. Run `git clone https://github.com/vividus-framework/vividus-studio.git`
2. Run `npm install -g yo generator-code`

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sudo npm install...?

README.md Outdated
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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Click Next, Add all ->, Finish

README.md Outdated
5. Set root directory to `<path-to-repo>/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`
Copy link

@ivan-lednev ivan-lednev Aug 8, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe remove the Eclipse -> part? On Linux & Windows Preferences is in a different menu

README.md Outdated
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`

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could not get the plugin working on on Ubuntu 20, and I had to install Eclipse for plugin developers

README.md Outdated
2. Run `cd vividus-starter && unset BUILD_SYSTEM_ROOT && ./gradlew runStories`
3. Nevigate to `<path-to-repo>/vividus-studio`
4. Run `code .`

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add npm install here

README.md Outdated
## Tools
* Node JS v12.13.0 or higher
* Open JDK 12.0.1 or higher
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't it be JDK 11 ?

README.md Outdated
* Node JS v12.13.0 or higher
* Open JDK 12.0.1 or higher
* Eclipse IDE 2019-09 R (4.13.0) or higher
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it would be good to make convert this items to links

README.md Outdated
7. Select `Projects with source folders` under `Import As` section
8. Click `Add all ->` and then `Finish` buttons
9. Add the follwing entries into `<path-to-repo>/vividus-studio/vividus-studio-server/vividus-studio-plugin/.classpath` XML file under `<classpath>` section and then refresh the project
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can't it be automated?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants