You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+58-7
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,39 @@
1
-
# create-lowcoder-plugin
1
+
# Lowcoder Component Builder
2
2
3
-
## How to build a Component Plugin
3
+
## How to build a Lowcoder Component Plugin
4
4
5
-
This script helps you to create a skeleton Lowcoder Component, which you can then publish on npm and use it as imported Plugin in any app.
5
+
This script helps you to create a skeleton Lowcoder Component, which you can then publish on npm and use it as imported Plugin in any app.
6
+
7
+
The main steps are:
8
+
9
+
- Fork of the repository
10
+
- Local installation
11
+
- Developing & preview the Component
12
+
- Publish the component
13
+
14
+
### Forking of the Repository
15
+
16
+
To ensure you can develop your Component Plugin including as your repository, please fort (update) our lowcoder-org/lowcoder-create-component-plugin repository first. Find here more information: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo
17
+
18
+
### Cloning of the new repository to work local
19
+
20
+
Now you can clone your new repository to develop local.
6
21
7
-
1) Navigate your terminal or bash to /client and install general dependencies
1) Navigate your terminal or bash to your /root folder of the cloned repository to install general dependencies and the Lowcoder SDK
33
+
```bash
10
34
yarn install
11
35
```
12
-
1) execute the Plugin Builder Script. PLease name your plugin with the prefix lowcoder-comp-
36
+
2) execute the Plugin Builder Script. PLease name your plugin with the prefix **"lowcoder-comp-"** to make it easy for other users to find Lowcoder Component Pluins on NPM
0 commit comments