feat(todo-list-example): improve the todo-list template (#320)

feat(todo-list-example): improve the todo-list template
blocklet · Apr 7, 2024 · 897f22e · 897f22e
1 parent c6aeab3
commit 897f22e
Show file tree

Hide file tree

Showing 24 changed files with 80 additions and 23 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.7.9 (2024-4-7)
+
+- feat(todo-list-example): improve the todo-list template
+
 ## 0.7.8 (2024-4-5)
 
 - fix: remove invalid eject command

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "create-blocklet",
   "private": true,
-  "version": "0.7.8",
+  "version": "0.7.9",
   "description": "",
   "scripts": {
     "debug": "node packages/create-app/index.js",

diff --git a/packages/create-app/package.json b/packages/create-app/package.json
@@ -1,6 +1,6 @@
 {
   "name": "create-blocklet",
-  "version": "0.7.8",
+  "version": "0.7.9",
   "exports": "./index.js",
   "type": "module",
   "repository": "git@github.com:blocklet/create-blocklet.git",

diff --git a/packages/create-app/templates/react-dapp-ts/package.json b/packages/create-app/templates/react-dapp-ts/package.json
@@ -78,7 +78,7 @@
     "ts-node": "^10.9.2",
     "typescript": "^5.3.3",
     "vite": "^5.0.10",
-    "vite-plugin-blocklet": "^0.7.8",
+    "vite-plugin-blocklet": "^0.7.9",
     "vite-plugin-svgr": "^4.2.0",
     "zx": "^7.2.3"
   },

diff --git a/packages/create-app/templates/react-dapp/package.json b/packages/create-app/templates/react-dapp/package.json
@@ -68,7 +68,7 @@
     "npm-run-all": "^4.1.5",
     "prettier": "^3.1.1",
     "vite": "^5.0.10",
-    "vite-plugin-blocklet": "^0.7.8",
+    "vite-plugin-blocklet": "^0.7.9",
     "vite-plugin-svgr": "^4.2.0",
     "zx": "^7.2.3"
   }

diff --git a/packages/create-app/templates/react-gun-dapp/package.json b/packages/create-app/templates/react-gun-dapp/package.json
@@ -69,7 +69,7 @@
     "prettier": "^3.1.1",
     "rimraf": "^3.0.2",
     "vite": "^5.0.10",
-    "vite-plugin-blocklet": "^0.7.8",
+    "vite-plugin-blocklet": "^0.7.9",
     "vite-plugin-svgr": "^4.2.0",
     "zx": "^7.2.3"
   }

diff --git a/packages/create-app/templates/react-static/package.json b/packages/create-app/templates/react-static/package.json
@@ -52,7 +52,7 @@
     "prettier": "^3.1.1",
     "rimraf": "^3.0.2",
     "vite": "^5.0.10",
-    "vite-plugin-blocklet": "^0.7.8",
+    "vite-plugin-blocklet": "^0.7.9",
     "vite-plugin-svgr": "^4.2.0",
     "zx": "^7.2.3"
   }

diff --git a/packages/create-app/templates/solidjs-dapp/package.json b/packages/create-app/templates/solidjs-dapp/package.json
@@ -33,7 +33,7 @@
     "prettier": "^3.1.1",
     "rimraf": "^3.0.2",
     "vite": "^5.0.10",
-    "vite-plugin-blocklet": "^0.7.8",
+    "vite-plugin-blocklet": "^0.7.9",
     "vite-plugin-solid": "^2.8.0",
     "zx": "^7.2.3"
   },

diff --git a/packages/create-app/templates/solidjs-static/package.json b/packages/create-app/templates/solidjs-static/package.json
@@ -29,7 +29,7 @@
     "prettier": "^3.1.1",
     "rimraf": "^3.0.2",
     "vite": "^5.0.10",
-    "vite-plugin-blocklet": "^0.7.8",
+    "vite-plugin-blocklet": "^0.7.9",
     "vite-plugin-solid": "^2.8.0",
     "zx": "^7.2.3"
   },

diff --git a/packages/create-app/templates/svelte-dapp/package.json b/packages/create-app/templates/svelte-dapp/package.json
@@ -45,7 +45,7 @@
     "rimraf": "^3.0.2",
     "svelte": "^4.2.8",
     "vite": "^5.0.10",
-    "vite-plugin-blocklet": "^0.7.8",
+    "vite-plugin-blocklet": "^0.7.9",
     "zx": "^7.2.3"
   },
   "lint-staged": {

diff --git a/packages/create-app/templates/svelte-static/package.json b/packages/create-app/templates/svelte-static/package.json
@@ -30,7 +30,7 @@
     "rimraf": "^3.0.2",
     "svelte": "^4.2.8",
     "vite": "^5.0.10",
-    "vite-plugin-blocklet": "^0.7.8",
+    "vite-plugin-blocklet": "^0.7.9",
     "zx": "^7.2.3"
   },
   "lint-staged": {

diff --git a/packages/create-app/templates/todo-list-example/blocklet.md b/packages/create-app/templates/todo-list-example/blocklet.md
@@ -1,3 +1,28 @@
-# template-react
+# todo-list-example
 
-A react template for creating a new blocklet project.
+## How to start
+
+### Install dependencies
+
+```shell
+pnpm install
+# or npm install
+# or yarn install
+```
+
+### Start
+
+```shell
+yarn dev
+```
+
+## How to connect with DID Spaces
+
+- Step 1: Set the 'capabilities.didSpace' field in blocklet.yml to 'requiredOnConnect', see 'blocklet.yml#capabilities'
+- Step 2: To read and write the DID Space, see api/src/routes/todo-list/index.ts#9
+- Step 3: Get data from DID Spaces, see 'src/pages/todo-list.tsx#33'
+- Step 4: Write data to DID Spaces, see 'src/pages/todo-list.tsx#51'
+
+## Get help
+
+If you want to learn more about the development of DID Spaces, You can also refer to [DID Spaces development documentation] (https://www.arcblock.io/docs/did-spaces/en/did-spaces-how-to-guides). No matter what you encounter a problem, we welcome you in our official BBS (https://community.arcblock.io/) initiated discussions.
diff --git a/packages/create-app/templates/todo-list-example/blocklet.yml b/packages/create-app/templates/todo-list-example/blocklet.yml
@@ -36,7 +36,7 @@ payment:
 timeout:
   start: 60
 requirements:
-  server: '>=1.6.29'
+  server: '>=1.16.25'
   os: '*'
   cpu: '*'
 scripts:

diff --git a/packages/create-app/templates/todo-list-example/blocklet.zh.md b/packages/create-app/templates/todo-list-example/blocklet.zh.md
@@ -0,0 +1,28 @@
+# todo-list-example
+
+## 如何启动
+
+### 安装依赖
+
+```shell
+pnpm install
+# or npm install
+# or yarn install
+```
+
+### 启动
+
+```shell
+yarn dev
+```
+
+## 如何与 DID Spaces 对接的
+
+- 步骤 1：将blocklet.yml 中的 `capabilities.didSpace` 字段设置为 `requiredOnConnect`，请参阅 `blocklet.yml#capabilities`
+- 步骤 2：实现读写 DID Space 的功能，请参阅 `api/src/routes/todo-list/index.ts#9`
+- 步骤 3：从 DID Spaces 获取数据，请参阅 `src/pages/todo-list.tsx#33`
+- 步骤 4：将数据写入 DID Spaces，请参阅 `src/pages/todo-list.tsx#51`
+
+## 获得帮助
+
+  如果你想了解更多有关 DID Spaces 的开发细节，你还可以参考[DID Spaces 的开发文档](https://www.arcblock.io/docs/did-spaces/en/did-spaces-how-to-guides)。不论你遇到什么问题，我们随时欢迎你在我们的[官方论坛](https://community.arcblock.io/)发起讨论。
diff --git a/packages/create-app/templates/todo-list-example/package.json b/packages/create-app/templates/todo-list-example/package.json
@@ -91,7 +91,7 @@
     "ts-node": "^10.9.2",
     "typescript": "^5.4.3",
     "vite": "^5.0.13",
-    "vite-plugin-blocklet": "^0.7.8",
+    "vite-plugin-blocklet": "^0.7.9",
     "vite-plugin-svgr": "^4.2.0",
     "zx": "^7.2.3"
   },

diff --git a/packages/create-app/templates/vue-dapp/package.json b/packages/create-app/templates/vue-dapp/package.json
@@ -47,7 +47,7 @@
     "prettier": "^3.1.1",
     "rimraf": "^3.0.2",
     "vite": "^5.0.10",
-    "vite-plugin-blocklet": "^0.7.8",
+    "vite-plugin-blocklet": "^0.7.9",
     "zx": "^7.2.3"
   },
   "lint-staged": {

diff --git a/packages/create-app/templates/vue-static/package.json b/packages/create-app/templates/vue-static/package.json
@@ -31,7 +31,7 @@
     "prettier": "^3.1.1",
     "rimraf": "^3.0.2",
     "vite": "^5.0.10",
-    "vite-plugin-blocklet": "^0.7.8",
+    "vite-plugin-blocklet": "^0.7.9",
     "zx": "^7.2.3"
   },
   "lint-staged": {

diff --git a/packages/create-app/templates/vue2-dapp/package.json b/packages/create-app/templates/vue2-dapp/package.json
@@ -47,7 +47,7 @@
     "prettier": "^3.1.1",
     "rimraf": "^3.0.2",
     "vite": "^5.0.10",
-    "vite-plugin-blocklet": "^0.7.8",
+    "vite-plugin-blocklet": "^0.7.9",
     "zx": "^7.2.3"
   },
   "lint-staged": {

diff --git a/packages/create-app/templates/vue2-static/package.json b/packages/create-app/templates/vue2-static/package.json
@@ -31,7 +31,7 @@
     "prettier": "^3.1.1",
     "rimraf": "^3.0.2",
     "vite": "^5.0.10",
-    "vite-plugin-blocklet": "^0.7.8",
+    "vite-plugin-blocklet": "^0.7.9",
     "zx": "^7.2.3"
   },
   "lint-staged": {

diff --git a/plugins/vite-plugin-blocklet/package.json b/plugins/vite-plugin-blocklet/package.json
@@ -1,7 +1,7 @@
 {
   "name": "vite-plugin-blocklet",
   "type": "module",
-  "version": "0.7.8",
+  "version": "0.7.9",
   "description": "",
   "main": "index.js",
   "files": [

diff --git a/plugins/vite-plugin-wss-hmr/package.json b/plugins/vite-plugin-wss-hmr/package.json
@@ -1,7 +1,7 @@
 {
   "name": "vite-plugin-wss-hmr",
   "type": "module",
-  "version": "0.7.8",
+  "version": "0.7.9",
   "description": "",
   "main": "index.js",
   "exports": {

diff --git a/version b/version
@@ -1 +1 @@
-0.7.8
+0.7.9
diff --git a/website/docs/blocklet.yml b/website/docs/blocklet.yml
@@ -13,7 +13,7 @@ repository:
   type: git
   url: git+https://github.com/blocklet/create-blocklet.git
 specVersion: 1.2.8
-version: 0.7.8
+version: 0.7.9
 logo: logo.png
 files:
   - logo.png

diff --git a/website/pages/blocklet.yml b/website/pages/blocklet.yml
@@ -13,7 +13,7 @@ repository:
   type: git
   url: git+https://github.com/blocklet/create-blocklet.git
 specVersion: 1.2.8
-version: 0.7.8
+version: 0.7.9
 logo: logo.png
 files:
   - logo.png