Skip to content

Commit 2008a06

Browse files
committed
Add dev doc
1 parent f9390c9 commit 2008a06

File tree

15 files changed

+64
-1
lines changed

15 files changed

+64
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,8 @@ SCSS, Spec, Storybook
77
# Install
88
Search for `React Component Creator` in the plugins settings. Or download the plugin from the [release site](https://github.com/faebeee/react-component-creator-plugin/releases)
99

10-
## Icons
10+
11+
# Development
12+
Follow the [Setup Instructions](./doc/DEVELOPMENT.md)
13+
# Icons
1114
Icons provided by https://www.iconfinder.com/justicon via https://www.iconfinder.com

doc/DEVELOPMENT.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Development
2+
First import the project into IntelliJ
3+
4+
## Import Project
5+
![Create component](./setup/step1.png "")
6+
7+
8+
## Select `Create from exising source`
9+
![Create component](./setup/step2.png "")
10+
11+
## Set Project name
12+
Leave as is
13+
14+
![Create component](./setup/step3.png "")
15+
16+
## Import
17+
Leave as is
18+
19+
![Create component](./setup/step4.png "")
20+
21+
22+
## Libraries
23+
Leave as is
24+
25+
![Create component](./setup/step5.png "")
26+
27+
## Modules
28+
Leave as is
29+
30+
![Create component](./setup/step6.png "")
31+
32+
## Project iml file
33+
Make sure to reuse the existing one
34+
35+
![Create component](./setup/step7.png "")
36+
37+
## SDK
38+
Leave as is
39+
40+
![Create component](./setup/step8.png "")
41+
42+
43+
# Setup
44+
Follow the setup to start developing the plugin
45+
46+
## Open Project Settings
47+
48+
![Create component](./setup/step9.png "")
49+
50+
## Add "library"
51+
In `Libraries` make sure to read `com.samskivert:jmustache:1.14` as maven dependency
52+
![Create component](./setup/step10.png "")
53+
54+
![Create component](./setup/step11.png "")
55+
56+
# Add Plugin Run configuration
57+
58+
![Create component](./setup/step12.png "")
59+
60+
![Create component](./setup/step13.png "")

doc/setup/step1.png

16.1 KB
Loading

doc/setup/step10.png

45.1 KB
Loading

doc/setup/step11.png

135 KB
Loading

doc/setup/step12.png

375 KB
Loading

doc/setup/step13.png

229 KB
Loading

doc/setup/step2.png

136 KB
Loading

doc/setup/step3.png

127 KB
Loading

doc/setup/step4.png

137 KB
Loading

0 commit comments

Comments
 (0)