Skip to content
On this page

Create your first tool

Step 1: Install He3 client

If you have already installed the latest He3 client, please ignore this step. If not, you can go to the official website to download https://he3.app/

He3 client version requirement: v1.3.0+

Step 2: Login He3 client

Open the He3 client, and select the login account in the top right corner.

Step 3: Create a tool

There are two ways to create a tool:

  • Fork the Demo repository
  • Create through portal form

Option1: Fork demo repository

Fork https://github.com/he3-app/he3-tool-demo repository, and clone it to your local.

WARNING

Modify the tool information in the package.json(correspond to he3 field configuration items) to ensure that the tool information is not duplicated with the remote tool warehouse, such as toolId, name, description and other fields

Option2: Create through portal

Open https://portal.he3app.com/create-tools, Fill in the tool information in the form, and click "Download Tool Template" to download the tool template zip file.

In addition, we have also prepared some open-source tools for your: tools-example

Step 4: Develop tool

Enter the tool directory downloaded in step 3, install dependencies and develop tool with hot reload.

Notice

npm command needs to be executed in node environment, please click nodejs to install

shell
npm install
npm run dev

Then, open the He3 client and check it out.

step3

Step 5: Publish tool

Once you are finished developing the tool, you can publish it to the He3 Store.

Before publishing, He3 can also automatically help you handle the internationalization of metadata. Refer to Internationalization

You can publish tool by running the following command.

shell
npm run publish

After publishing, you will get the tool's URL link, which you can use by opening tool or share with others.

In addition, You can see the tool in My tools menu and He3 Store