From 6e53fd53ae11194fa4fe53975fcf6b4c5d0241e6 Mon Sep 17 00:00:00 2001 From: Chushen Date: Mon, 27 Nov 2023 17:56:04 +0800 Subject: [PATCH 1/2] chore: update deploy workflow --- .github/workflows/deploy.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index ca522ca5944..41a282577fc 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -10,6 +10,9 @@ jobs: deploy-site: runs-on: ubuntu-latest steps: + - uses: pnpm/action-setup@v2 + with: + version: 8 - uses: actions/checkout@v2 - run: pnpm install - run: pnpm build From e9f049598b11da1dda2a67834020805520462913 Mon Sep 17 00:00:00 2001 From: Chushen Date: Mon, 27 Nov 2023 18:02:45 +0800 Subject: [PATCH 2/2] docs: update readme with start project --- README.en-US.md | 22 ++++++++++++++++------ README.md | 25 ++++++++++++++++++------- package.json | 3 ++- 3 files changed, 36 insertions(+), 14 deletions(-) diff --git a/README.en-US.md b/README.en-US.md index cef9ff20d01..c47a40f7b05 100644 --- a/README.en-US.md +++ b/README.en-US.md @@ -1,6 +1,6 @@ # 🔥🔥G6 5.0 Beta is Released！🔥🔥 -## **💻 Try it Online ** +## **💻 Try it Online** [v5 Site](https://g6-next.antv.antgroup.com/en/) | [Features Demos](https://g6-next.antv.antgroup.com/en/examples) @@ -8,8 +8,7 @@ [How to Upgrade](https://g6-next.antv.antgroup.com/en/manual/upgrade) - -## **🌌 v5 Screen Shots ** +## **🌌 v5 Screen Shots** [See the Full Image](https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*qPrmQrdV77gAAAAAAAAAAAAADmJ7AQ/original) @@ -17,10 +16,8 @@ [See the Full Image](https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*1BFvQ4r3P7UAAAAAAAAAAAAADmJ7AQ/original) - - # G6: A Graph Visualization Framework in TypeScript ![](https://user-images.githubusercontent.com/6113694/45008751-ea465300-b036-11e8-8e2a-166cbb338ce2.png) @@ -43,7 +40,6 @@ - ## Features - Abundant Built-in Items: Nodes and edges with free configurations; @@ -185,10 +181,24 @@ Welcome to join the **G6 Communication Group** or **G6 Communication Group-2** (

+ ## How to Contribute Please let us know what you are you going to help. Do check out [issues](https://github.com/antvis/g6/issues) for bug reports or suggestions first. +### Start Project + +```bash +# Install dependencies (with pnpm) +pnpm install + +# Build +pnpm build + +# Start the dev server +pnpm start +``` + ## License [MIT license](./LICENSE). diff --git a/README.md b/README.md index 70e42a3fb92..bcd2668aa69 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,7 @@ ## **📹 Alpha 直播回顾** -[📺 B站](https://www.bilibili.com/video/BV16u4y1d7kv/?share_source=copy_web&vd_source=8b3a1125d63f0a33dbd2501181fd43bf) | [💬 微信](https://mp.weixin.qq.com/s/2hVjFX-oHRob634Cd6nr-w) - +[📺 B 站](https://www.bilibili.com/video/BV16u4y1d7kv/?share_source=copy_web&vd_source=8b3a1125d63f0a33dbd2501181fd43bf) | [💬 微信](https://mp.weixin.qq.com/s/2hVjFX-oHRob634Cd6nr-w) ## **🌌 精彩截图** @@ -21,15 +20,14 @@ [查看大图](https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*1BFvQ4r3P7UAAAAAAAAAAAAADmJ7AQ/original) - ## 猎捕计划 -* 🎉 认领 Issue —— 在该 Issue 评论区回复 -* 🆗 解决 Issue —— 提交 PR，并根据管理员 CR 进行修改 -* ✅ 管理员确认完成，合并到主干分支 -* 💰 获得奖金 —— 管理员手动支付 +- 🎉 认领 Issue —— 在该 Issue 评论区回复 +- 🆗 解决 Issue —— 提交 PR，并根据管理员 CR 进行修改 +- ✅ 管理员确认完成，合并到主干分支 +- 💰 获得奖金 —— 管理员手动支付 更多信息详见 [Issue Hunt](https://github.com/antvis/G6/blob/master/ISSUEHUNT.md) @@ -207,6 +205,19 @@ DEBUG_MODE=1 npm test -- --watch ./tests/unit/algorithm/find-path-spec 请让我们知道您要解决或贡献什么，所以在贡献之前请先提交 [issues](https://github.com/antvis/g6/issues) 描述 bug 或建议。 +### 项目启动 + +```bash +# 安装依赖 (请使用 pnpm) +pnpm install + +# 构建 +pnpm build + +# 启动站点 +pnpm start +``` + ## License [MIT license](./LICENSE). diff --git a/package.json b/package.json index cda8560896b..fd534099e35 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,7 @@ ], "scripts": { "build:demos": "cd ./packages/pc && npm run demos", - "build:site": "cd ./packages/site && npm run start", + "build:site": "cd ./packages/site && npm run site:build", "build:core": "cd ./packages/core && npm run build", "build:element": "cd ./packages/element && npm run build", "build:plugin": "cd ./packages/plugin && npm run build", @@ -21,6 +21,7 @@ "lint:g6": "cd ./packages/g6 && npm run lint", "lint:all": "npm run lint:core && npm run lint:element && npm run lint:plugin && npm run lint:pc && npm run lint:g6", "build": "npm run build:all", + "start": "cd ./packages/site && npm run start", "lint": "npm run lint:all", "test:core": "cd ./packages/core && npm run test", "test:element": "cd ./packages/element && npm run test",