Skip to content

Commit ba26219

Browse files
committed
docs(dev-guide): update open-source and multi-end architecture docs
Signed-off-by: jackiexiao <707610215@qq.com>
1 parent 607a73e commit ba26219

7 files changed

Lines changed: 76 additions & 28 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,18 @@ HackathonWeekly(周周黑客松)社区平台 —— 一个面向创造者的
66

77
📖 详细文档:https://hackathonweekly.com/zh/docs
88

9+
## 仓库与多端支持
10+
11+
- Web(手机端 + 桌面端):https://github.com/hackathonweekly/community
12+
- 微信小程序端(WebView 容器):https://github.com/hackathonweekly/mini-community
13+
14+
社区平台支持:
15+
- 手机号登录 + 微信登录(PC 扫码 / 手机授权)
16+
- 活动创建与举办流程
17+
- 数字名片与项目展示
18+
- 多组织管理与邮件通知
19+
- 微信支付接入
20+
921
## 许可证
1022

1123
- 代码:[MIT License](LICENSE) — 你可以自由使用、修改、分发,包括商业用途

apps/web/content/docs/dev-guide/authentication.zh.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ description: "Better Auth 配置、登录方式和会话管理"
1414

1515
| 方式 | 状态 | 说明 |
1616
|------|------|------|
17+
| 手机号登录(手机 + PC) || 短信验证码登录,适合作为统一兜底登录方式 |
18+
| 微信扫码(PC) || 自定义插件 `wechat-oauth`,支持 PC 扫码登录 |
19+
| 微信授权(手机) || 微信内 H5 授权登录 |
1720
| 邮箱 + 密码 || 默认启用 |
1821
| GitHub OAuth || 需配置 Client ID/Secret |
1922
| Google OAuth || 需配置 Client ID/Secret |
20-
| 微信扫码(PC) || 自定义插件 `wechat-oauth` |
21-
| 微信授权(手机) || 微信内 H5 授权登录 |
22-
| 手机号登录 || 短信验证码 |
2323
| Magic Link | ⚙️ | 可通过 feature flag 启用 |
2424
| 双因素认证 (2FA) | ⚙️ | 可通过 feature flag 启用 |
2525

@@ -44,6 +44,8 @@ description: "Better Auth 配置、登录方式和会话管理"
4444
1. PC 端:展示微信二维码 → 用户扫码 → 回调获取 code → 换取 access_token → 获取用户信息
4545
2. 手机端:微信内打开 → 静默授权 → 获取 code → 换取用户信息
4646

47+
项目已配置微信 PC/移动端账号互信,可将同一用户在不同端的微信登录记录关联到同一个账号。
48+
4749
配置环境变量:
4850
```bash
4951
WECHAT_APP_ID="your-wechat-app-id"

apps/web/content/docs/dev-guide/contributing.zh.mdx

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,14 @@ description: "如何参与社区网站开发"
55

66
## 如何参与
77

8-
我们欢迎大家参与到社区网站的开发中来!也欢迎有相同理念的小伙伴/各地的黑客松社区在我们的基础上进行二次开发
8+
我们欢迎大家参与到社区网站的开发中来!也欢迎有相同理念的小伙伴或各地黑客松社区基于我们的代码进行二次开发
99

10-
我们将向公益组织/非盈利性活动提供技术支持和开放代码授权。商业授权需要沟通协商。
10+
## 仓库说明
1111

12-
### 联系方式
13-
14-
**邮箱**: contact@HackathonWeekly.com
15-
16-
**邮件模板**:
17-
- 您/您组织的自我介绍,期望的合作模式
18-
- 您擅长的技术栈
19-
- 您为什么想要加入社区网站开发 / 获取授权
20-
- 您的微信或其他联系方式
12+
- Web 主仓库(手机端 + 桌面端):
13+
[hackathonweekly/community](https://github.com/hackathonweekly/community)
14+
- 小程序端仓库(WebView 容器):
15+
[hackathonweekly/mini-community](https://github.com/hackathonweekly/mini-community)
2116

2217
## 贡献建议
2318

@@ -51,7 +46,7 @@ git checkout -b feature/my-feature
5146

5247
# 4. 开发并提交
5348
git add .
54-
git commit -m "feat(scope): add my feature"
49+
git commit -s -m "feat(scope): add my feature"
5550

5651
# 5. 推送到你的 Fork
5752
git push origin feature/my-feature
@@ -67,18 +62,17 @@ git push origin feature/my-feature
6762
- UI 变更附带截图
6863
- 遵循 [编码规范](/docs/dev-guide/coding-standards)
6964

70-
## 许可证
65+
## 许可证与贡献声明
7166

72-
- 代码: [AGPL-3.0](https://github.com/hackathonweekly/community/blob/main/LICENSE)
67+
- 代码: [MIT](https://github.com/hackathonweekly/community/blob/main/LICENSE)
7368
- 内容: [CC BY-SA 4.0](https://github.com/hackathonweekly/community/blob/main/LICENSE-CONTENT)
69+
- 贡献方式: [DCO](https://github.com/hackathonweekly/community/blob/main/DCO.md)(提交时使用 `git commit -s`
7470

75-
AGPL-3.0 要求:如果你将修改后的版本部署为网络服务,需要将修改部分以 AGPL-3.0 开源。如需闭源商业使用,请联系我们获取商业许可。
76-
77-
详细说明请参阅 [开源许可与贡献者协议](/docs/licensing)
71+
详细说明请参阅 [开源许可与贡献方式](/docs/licensing)
7872

7973
## 相关文档
8074

8175
- [贡献指南 (GitHub)](https://github.com/hackathonweekly/community/blob/main/CONTRIBUTING.md)
8276
- [开发规范](https://github.com/hackathonweekly/community/blob/main/DEVELOPMENT.md)
8377
- [行为准则](https://github.com/hackathonweekly/community/blob/main/CODE_OF_CONDUCT.md)
84-
- [贡献者协议 (CLA)](https://github.com/hackathonweekly/community/blob/main/CLA.md)
78+
- [DCO 声明](https://github.com/hackathonweekly/community/blob/main/DCO.md)

apps/web/content/docs/dev-guide/getting-started.zh.mdx

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@ title: "快速开始"
33
description: "5 分钟搭建本地开发环境"
44
---
55

6+
## 代码仓库
7+
8+
- 社区 Web(主仓库):[hackathonweekly/community](https://github.com/hackathonweekly/community)
9+
- 小程序端(WebView 容器):[hackathonweekly/mini-community](https://github.com/hackathonweekly/mini-community)
10+
611
## 前置要求
712

813
- **Node.js 20+**: [下载地址](https://nodejs.org/)
@@ -12,7 +17,7 @@ description: "5 分钟搭建本地开发环境"
1217
## 快速启动
1318

1419
```bash
15-
# 1. 克隆项目(源码暂未开源,敬请期待)
20+
# 1. 克隆项目
1621
git clone https://github.com/hackathonweekly/community.git
1722
cd community
1823

@@ -47,6 +52,15 @@ pnpm dev
4752

4853
访问 [http://localhost:3000](http://localhost:3000) 查看网站。
4954

55+
## 小程序端说明(WebView)
56+
57+
小程序端代码位于独立仓库 `hackathonweekly/mini-community`,主要通过 WebView 承载社区 H5 页面。
58+
59+
使用前请确认:
60+
- 小程序主体为企业资质(WebView/业务域名配置通常需要企业主体)
61+
- 已在微信小程序后台配置合法业务域名(HTTPS)
62+
- Web 站点可正常访问(建议先完成本仓库部署)
63+
5064
## 开发工具入口
5165

5266
| 工具 | 地址 | 说明 |

apps/web/content/docs/dev-guide/index.zh.mdx

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
---
22
title: "社区网站开发指南"
3-
description: "Hackathon Weekly 社区网站的完整开发指南,为社区成员提供快速入门指引"
3+
description: "Hackathon Weekly 社区网站的完整开发指南,包含开源仓库、多端架构和核心能力说明"
44
---
55

6-
<Callout title="重要提醒" type="warn">
7-
社区源码暂未公开,敬请期待!如有合作需求可联系: makerjackie,注明来意
6+
<Callout title="开源仓库" type="info">
7+
社区 Web 仓库:[hackathonweekly/community](https://github.com/hackathonweekly/community)<br />
8+
小程序端仓库:[hackathonweekly/mini-community](https://github.com/hackathonweekly/mini-community)<br />
9+
小程序端通过 WebView 方式承载页面,需要微信小程序企业主体资质并完成业务域名配置。
810
</Callout>
911

1012
欢迎来到 **Hackathon Weekly 社区网站**开发指南!本文档帮助你快速了解项目并开始贡献。
@@ -17,13 +19,25 @@ description: "Hackathon Weekly 社区网站的完整开发指南,为社区成
1719
| UI 组件 | Shadcn/ui + Radix UI |
1820
| 后端 API | Hono.js |
1921
| 数据库 | PostgreSQL + Prisma ORM |
20-
| 认证 | Better Auth(邮箱、GitHub、Google、微信|
22+
| 认证 | Better Auth(手机号、微信登录,支持 PC + 手机|
2123
| 国际化 | next-intl |
2224
| 文档 | Fumadocs (MDX) |
2325
| 部署 | Zeabur + Docker |
2426
| 代码质量 | Biome + Husky |
2527
| 测试 | Playwright (E2E) |
2628

29+
## 社区平台特色
30+
31+
| 能力 | 说明 |
32+
|------|------|
33+
| 多端支持 | 一套 Web 代码同时支持手机端与桌面端;小程序端通过 WebView 接入 |
34+
| 登录体系 | 手机号验证码登录 + 微信登录(PC 扫码、手机微信授权) |
35+
| 活动系统 | 支持活动创建、发布、报名、管理等基础活动举办流程 |
36+
| 数字名片与项目展示 | 支持成员数字名片、项目展示与活动现场名片展示 |
37+
| 多组织管理 | 支持组织创建、成员邀请、角色权限管理 |
38+
| 通知能力 | 支持邮件通知等运营触达能力 |
39+
| 支付能力 | 支持微信支付能力接入 |
40+
2741
## 从哪里开始
2842

2943
- **[快速开始](/docs/dev-guide/getting-started)** — 5 分钟跑起来

apps/web/content/docs/dev-guide/project-structure.zh.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,17 @@ description: "Monorepo 目录组织和各模块职责说明"
55

66
本项目采用 **Turborepo + pnpm workspace** 的 monorepo 结构。
77

8+
## 多端架构
9+
10+
|| 仓库 | 说明 |
11+
|------|------|------|
12+
| 手机端 + 桌面端 Web | `hackathonweekly/community` | 同一套 Next.js 响应式页面,通过断点适配移动端和桌面端 |
13+
| 微信小程序端 | `hackathonweekly/mini-community` | 通过 WebView 承载社区页面,作为小程序壳层接入 |
14+
15+
<Callout title="小程序接入提示" type="warn">
16+
微信小程序 WebView 接入通常需要企业主体资质,并在小程序后台完成合法业务域名配置。
17+
</Callout>
18+
819
## 顶层目录
920

1021
```

apps/web/content/docs/index.zh.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,8 @@ description: 一个AI创造者社区,用AI帮助千万创造者打造有价值
9898

9999
- **官网**[hackathonweekly.com](https://hackathonweekly.com)
100100
- **飞书协作文档**[docs.hackathonweekly.com](https://docs.hackathonweekly.com)
101-
- **GitHub**[github.com/hackathonweekly/community](https://github.com/hackathonweekly/community)
101+
- **GitHub(Web)**[github.com/hackathonweekly/community](https://github.com/hackathonweekly/community)
102+
- **GitHub(小程序)**[github.com/hackathonweekly/mini-community](https://github.com/hackathonweekly/mini-community)
102103
- **微信公众号**`HackathonWeekly`
103104
- **想参与社区网站开发?**:查看 [网站开发指南](./dev-guide/getting-started)
104105

@@ -121,4 +122,4 @@ description: 一个AI创造者社区,用AI帮助千万创造者打造有价值
121122

122123
💡 **花1周时间,创造1个MVP,解决1个痛点,也许就是下1个改变世界的起点。**
123124

124-
**欢迎回家,一起创造!** ❤️
125+
**欢迎回家,一起创造!** ❤️

0 commit comments

Comments
 (0)