Skip to content

Commit

Permalink
[feat] HertzBeat Official Template Marketplace [apache#1792]
Browse files Browse the repository at this point in the history
  • Loading branch information
All-The-Best-for committed Oct 29, 2024
1 parent 4017ddf commit 5e2d409
Showing 1 changed file with 34 additions and 36 deletions.
70 changes: 34 additions & 36 deletions home/docs/help/template_marketplace.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: template_marketplace
title: Template Marketplace
id: template_marketplace
title: Template Marketplace
sidebar_label: Template Marketplace
---

Expand All @@ -21,14 +21,14 @@ sidebar_label: Template Marketplace
2. **Filtering by category: currently divided into six categories**

> **📋Todo:** develop tag function, subdivided within the category, such as database monitoring template can be divided into MySQL, Oracle, etc.
![search-category.png](template-marketplace-img/search-category.png)

3. **Fuzzy search by Title**

![search-name.png](template-marketplace-img/search-name.png)

4. **Hover window function: download the latest version, view details, favorite/unfavorite**
4. **Hover window function: download the latest version, view details, favorite/un-favorite**

> Show if the user has favorites after logging in
Expand All @@ -47,7 +47,7 @@ sidebar_label: Template Marketplace
1. **Info: Summary information, detailed information and other information**

> **📋Todo:** Upgrade to MarkDown format
![img.png](template-marketplace-img/detail-info.png)

2. **Version: Historical version download, sharing and basic information display**
Expand All @@ -64,61 +64,58 @@ sidebar_label: Template Marketplace

4. **Download**

> The latest version can be downloaded directly from the list hover window
>
> The latest version can also be downloaded directly from the template detail page
>
> The historical version can be downloaded from the version page
> The latest version can be downloaded directly from the list hover window.
> The latest version can also be downloaded directly from the template detail page.
> The historical version can be downloaded from the version page.
![img.png](template-marketplace-img/download.png)

5. **Share**

> Template details page to share the latest version
>
>Version page to share historical versions
>
> Sharing will automatically copy the sharing URL to the clipboard, and the person being shared can download the file via that URL
> Template details page to share the latest version.
> Version page to share historical versions.
> Sharing will automatically copy the sharing URL to the clipboard, and the person being shared can download the file via that URL
>
> **📋Todo:** Shared template detail page is accessed through the URL of the shared template, and the shared person is free to choose whether to download or not.
![img.png](template-marketplace-img/share.png)


### User Center

💡 User availability

> Provide asset management, collection management and upload function
> Provide asset management, collection management and upload function
>
> **📋Todo:** Overview page, notification page, user settings page
1. **Asset: Manage all templates uploaded by user themselves**

> Provides the ability to download the latest version and view details

> Provides the ability to download the latest version and view details
>
> **📋Todo:** Function to update template information
![img_1.png](template-marketplace-img/user-center-asset.png)

![img.png](template-marketplace-img/asset-detail.png)

2. **Version Upgrade**

> The user defines the new version number under this template family, updates the version information, and uploads the latest version of the file
![img.png](template-marketplace-img/asset-upgrade.png)

3. **Star**

![img.png](template-marketplace-img/user-center-star.png)

![img.png](template-marketplace-img/user-center-star-detail.png)

4. **Upload**

> Create a new template series and upload the first version of the file
> Create a new template series and upload the first version of the file
>
> Fill in the template name, select the template category, fill in the description information and version information, and upload files
![img.png](template-marketplace-img/user-center-upload.png)

### Sign Up & Login
Expand All @@ -127,8 +124,8 @@ sidebar_label: Template Marketplace

1. **Sign up**

> Usernames can be duplicated, but email addresses are unique
> Usernames can be duplicated, but email addresses are unique
>
> **📋Todo:** Captcha function, email verification function
![img.png](template-marketplace-img/sign-up.png)
Expand All @@ -142,13 +139,14 @@ sidebar_label: Template Marketplace
## Development Steps

> Download `template-marketplace/hertzbeat-template-hub` and `template-marketplace/hertzbeat-template-hub-web-app` projects respectively
>
> The front-end project in accordance with README.md directly start
>
> The back-end project steps:
> 1. Run the `sql` script in the `template-marketplace/hertzbeat-template-hub/sql` to create database tables
> 2. Install MinIO
> 3. Config `MySQL` and `MinIO` in the application.yml
> 4. Start the back-end project
The front-end project in accordance with README.md directly start

The back-end project steps:

1. Run the `sql` script in the `template-marketplace/hertzbeat-template-hub/sql` to create database tables
2. Install MinIO
3. Config `MySQL` and `MinIO` in the `application.yml`
4. Start the back-end project

Other issues can be fed back through the communication group ISSUE!

0 comments on commit 5e2d409

Please sign in to comment.