docs: add comprehensive README

- Add project introduction and features - Add quick start guide (development and production) - Add configuration documentation - Add usage instructions - Add mobile support section - Add development guide and directory structure
fix: correct pnpm setup in GitHub Actions
2026-01-18 17:52:39 +08:00 · 2026-01-18 17:35:34 +08:00 · 2026-01-18 17:12:07 +08:00 · 2026-01-18 14:04:36 +08:00
6 changed files with 400 additions and 25 deletions
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -0,0 +1,106 @@
+name: Release Binaries
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    name: Build and Release
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - goos: linux
+            goarch: amd64
+            suffix: linux-amd64
+          - goos: linux
+            goarch: arm64
+            suffix: linux-arm64
+          - goos: darwin
+            goarch: amd64
+            suffix: darwin-amd64
+          - goos: darwin
+            goarch: arm64
+            suffix: darwin-arm64
+          - goos: windows
+            goarch: amd64
+            suffix: windows-amd64
+            ext: .exe
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.24'
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 8
+
+      - name: Get pnpm store directory
+        id: pnpm-cache
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
+
+      - name: Setup pnpm cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Print build info
+        run: |
+          echo "Tag: ${{ github.ref_name }}"
+          echo "GoOS: ${{ matrix.goos }}"
+          echo "GoArch: ${{ matrix.goarch }}"
+
+      - name: Build frontend
+        working-directory: frontend
+        run: |
+          pnpm install --registry=https://registry.npmmirror.com
+          pnpm run build
+
+      - name: Copy frontend dist for embedding
+        run: |
+          mkdir -p internal/static/frontend
+          cp -r frontend/dist internal/static/frontend/
+
+      - name: Build binary
+        env:
+          GOOS: ${{ matrix.goos }}
+          GOARCH: ${{ matrix.goarch }}
+          CGO_ENABLED: 0
+        run: |
+          OUTPUT_NAME="ushare-${{ matrix.suffix }}${{ matrix.ext }}"
+          go build -ldflags '-s -w' -o "$OUTPUT_NAME" .
+          chmod +x "$OUTPUT_NAME"
+
+      - name: Generate checksums
+        run: |
+          OUTPUT_NAME="ushare-${{ matrix.suffix }}${{ matrix.ext }}"
+          sha256sum "$OUTPUT_NAME" > "$OUTPUT_NAME.sha256"
+
+      - name: Upload to release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: |
+            ushare-${{ matrix.suffix }}${{ matrix.ext }}
+            ushare-${{ matrix.suffix }}${{ matrix.ext }}.sha256
+          draft: false
+          prerelease: false
--- a/README.md
+++ b/README.md
@@ -0,0 +1,168 @@
+# UShare
+
+一个简单易用的文件分享工具，支持大文件分片上传下载，以及局域网内 P2P 文件分享。
+
+## 功能特性
+
+- 📁 大文件分片上传下载
+- 🌐 网页端文件分享
+- 🏠 局域网 P2P 文件分享（WebRTC）
+- 📱 响应式设计，支持移动端
+- 🔐 简单的用户认证
+- 🚀 单一二进制，开箱即用
+- 🐳 Docker 支持
+
+## 快速开始
+
+### 开发模式
+
+```bash
+# 克隆仓库
+git clone https://github.com/loveuer/ushare.git
+cd ushare
+
+# 启动开发服务器
+./dev.sh
+```
+
+开发服务器会同时启动后端（http://0.0.0.0:9119）和前端（http://0.0.0.0:5173），前端支持热重载。
+
+### 生产模式
+
+#### 使用预编译二进制
+
+从 [Releases](https://github.com/loveuer/ushare/releases) 下载对应平台的二进制文件。
+
+```bash
+# Linux amd64
+wget https://github.com/loveuer/ushare/releases/download/v0.3.2/ushare-linux-amd64
+chmod +x ushare-linux-amd64
+
+# 运行
+./ushare-linux-amd64 -data ./data
+```
+
+#### 从源码构建
+
+```bash
+# 构建单一二进制（包含嵌入的前端）
+./make.sh
+
+# 运行
+./dist/ushare -data ./data
+```
+
+#### Docker 部署
+
+```bash
+docker build -t ushare:latest .
+docker run -d -p 80:80 -v $(pwd)/data:/data ushare:latest
+```
+
+## 配置
+
+### 命令行参数
+
+```bash
+ushare [options]
+
+Options:
+  -debug          启用调试模式
+  -address string  监听地址 (default "0.0.0.0:9119")
+  -data string     数据目录 (default "/data")
+  -clean int       文件清理周期，单位：小时，0 表示不自动清理 (default 24)
+```
+
+### 环境变量
+
+| 环境变量 | 说明 | 默认值 |
+|---------|------|--------|
+| `USHARE_USERNAME` | 用户名 | `admin` |
+| `USHARE_PASSWORD` | 密码 | `ushare@123` |
+
+#### 示例
+
+```bash
+# 使用默认凭据（admin / ushare@123）
+./ushare -data ./data
+
+# 使用自定义凭据
+export USHARE_USERNAME=myuser
+export USHARE_PASSWORD=mypass
+./ushare -data ./data
+```
+
+## 使用说明
+
+### 文件分享
+
+1. 访问 http://localhost:9119/share
+2. 点击"选择文件"选择要上传的文件
+3. 点击"上传文件"，等待上传完成
+4. 复制生成的下载码分享给他人
+
+### 文件下载
+
+1. 访问 http://localhost:9119/share
+2. 在"获取文件"区域输入下载码
+3. 点击"获取文件"下载文件
+
+### 局域网 P2P 分享
+
+1. 访问 http://localhost:9119
+2. 自动注册到局域网设备列表
+3. 选择要分享的设备，建立 P2P 连接
+4. 开始文件传输
+
+## 移动端支持
+
+- 响应式设计，自动适配手机、平板等设备
+- 移动端（≤768px）采用垂直布局，优化触摸操作
+- 按钮尺寸优化，适合手指点击
+
+## 开发
+
+### 目录结构
+
+```
+ushare/
+├── internal/          # 后端代码
+│   ├── api/         # HTTP API 路由
+│   ├── controller/  # 业务逻辑
+│   ├── handler/     # 请求处理器
+│   ├── model/       # 数据模型
+│   ├── opt/         # 配置管理
+│   └── pkg/         # 工具包
+├── frontend/         # 前端代码
+│   └── src/
+│       ├── api/     # API 调用
+│       ├── component/  # UI 组件
+│       ├── hook/    # 自定义 Hooks
+│       ├── page/    # 页面组件
+│       └── store/   # 状态管理
+├── .github/workflows/  # GitHub Actions
+├── dist/            # 构建输出（.gitignore）
+└── data/            # 数据目录（.gitignore）
+```
+
+### 构建
+
+```bash
+# 开发构建（前后端分离）
+./dev.sh
+
+# 生产构建（单一二进制）
+./make.sh
+```
+
+### 代码风格
+
+请参考 [AGENTS.md](./AGENTS.md) 了解代码风格指南。
+
+## License
+
+MIT License
+
+## 贡献
+
+欢迎提交 Issue 和 Pull Request！
--- a/frontend/src/page/share/component/panel-left.tsx
+++ b/frontend/src/page/share/component/panel-left.tsx
@@ -11,6 +11,12 @@ const useUploadStyle = createUseStyles({
        display: "flex",
        justifyContent: "center",
        alignItems: "center",
+        minHeight: "50vh",
+
+        "@media (max-width: 768px)": {
+            minHeight: "auto",
+            padding: "20px 10px",
+        },
    },
    form: {
        backgroundColor: "#C8E6C9",
@@ -19,10 +25,20 @@ const useUploadStyle = createUseStyles({
        borderRadius: "15px",
        width: "70%",
        margin: "20px 60px 20px 0",
-        /*todo margin 不用 px*/
+
+        "@media (max-width: 768px)": {
+            width: "90%",
+            margin: "20px 0",
+            padding: "20px",
+        },
    },
    title: {
-        color: "#2c9678"
+        color: "#2c9678",
+
+        "@media (max-width: 768px)": {
+            fontSize: "1.5rem",
+            marginBottom: "15px",
+        },
    },
    file: {
        display: 'none',
@@ -33,7 +49,11 @@ const useUploadStyle = createUseStyles({
    },
    name: {
        color: "#2c9678",
-        marginLeft: '10px'
+        marginLeft: '10px',
+
+        "@media (max-width: 768px)": {
+            fontSize: "14px",
+        },
    },
    clean: {
        borderRadius: '50%',
@@ -48,14 +68,12 @@ const useShowStyle = createUseStyles({
        display: "flex",
        justifyContent: "center",
        alignItems: "center",
-        position: "relative", // 为关闭按钮提供定位基准
+        minHeight: "50vh",
+
+        "@media (max-width: 768px)": {
+            minHeight: "auto",
+            padding: "20px 10px",
        },
-    title: {
-        color: "#2c9678",
-        marginTop: 0,
-        display: "flex",
-        justifyContent: "space-between",
-        alignItems: "center",
    },
    form: {
        backgroundColor: "#C8E6C9",
@@ -65,6 +83,25 @@ const useShowStyle = createUseStyles({
        width: "70%",
        margin: "20px 60px 20px 0",
        position: "relative",
+
+        "@media (max-width: 768px)": {
+            width: "90%",
+            margin: "20px 0",
+            padding: "20px",
+        },
+    },
+    title: {
+        color: "#2c9678",
+        marginTop: 0,
+        marginBottom: "25px",
+        display: "flex",
+        justifyContent: "space-between",
+        alignItems: "center",
+
+        "@media (max-width: 768px)": {
+            fontSize: "1.5rem",
+            marginBottom: "15px",
+        },
    },
    closeButton: {
        position: "absolute",
@@ -78,9 +115,7 @@ const useShowStyle = createUseStyles({
        height: "24px",
        cursor: "pointer",
        "&:hover": {
-            // background: "#cc0000",
            boxShadow:  "20px 20px 60px #fff, -20px -20px 60px #fff",
-            // boxShadow:  "20px 20px 60px #eee",
        },
    },
    codeWrapper: {
@@ -89,6 +124,10 @@ const useShowStyle = createUseStyles({
        borderRadius: "8px",
        margin: "15px 0",
        overflowX: "auto",
+
+        "@media (max-width: 768px)": {
+            padding: "0 10px",
+        },
    },
    pre: {
        display: 'flex',
@@ -98,6 +137,12 @@ const useShowStyle = createUseStyles({
        height: '24px',
        "& > code": {
            marginLeft: "0",
+            fontSize: "14px",
+            wordBreak: "break-all",
+
+            "@media (max-width: 768px)": {
+                fontSize: "12px",
+            },
        }
    },
    copyButton: {
@@ -112,6 +157,11 @@ const useShowStyle = createUseStyles({
        "&:hover": {
            background: "#1f6d5a",
        },
+
+        "@media (max-width: 768px)": {
+            padding: "6px 12px",
+            fontSize: "12px",
+        },
    },
 });

--- a/frontend/src/page/share/component/panel-mid.tsx
+++ b/frontend/src/page/share/component/panel-mid.tsx
@@ -5,6 +5,10 @@ const useStyle = createUseStyles({
        backgroundColor: 'lightgray',
        position: "relative",
        overflow: "hidden",
+
+        "@media (max-width: 768px)": {
+            display: "none",
+        },
    },
    left: {
        backgroundColor: "#e3f2fd",
--- a/frontend/src/page/share/component/panel-right.tsx
+++ b/frontend/src/page/share/component/panel-right.tsx
@@ -8,6 +8,12 @@ const useStyle = createUseStyles({
        display: "flex",
        justifyContent: "center",
        alignItems: "center",
+        minHeight: "50vh",
+
+        "@media (max-width: 768px)": {
+            minHeight: "auto",
+            padding: "20px 10px",
+        },
    },
    form: {
        backgroundColor: "#BBDEFB",
@@ -16,21 +22,54 @@ const useStyle = createUseStyles({
        borderRadius: "15px",
        width: "70%",
        margin: "20px 0 20px 60px",
-        /*todo margin 不用 px*/
+
+        "@media (max-width: 768px)": {
+            width: "90%",
+            margin: "20px 0",
+            padding: "20px",
+        },
    },
    title: {
-        color: '#1661ab', // 靛青
+        color: '#1661ab',
+
+        "@media (max-width: 768px)": {
+            fontSize: "1.5rem",
+            marginBottom: "15px",
+        },
    },
    code: {
        padding: '11px',
-        margin: '20px 0',
+        margin: '0',
        width: '200px',
        border: '2px solid #ddd',
        borderRadius: '5px',
        '&:active': {
            border: '2px solid #1661ab',
-        }
-    }
+        },
+
+        "@media (max-width: 768px)": {
+            width: '100%',
+            boxSizing: 'border-box',
+            padding: '10px',
+            fontSize: '14px',
+        },
+    },
+    inputContainer: {
+        display: 'flex',
+        gap: '10px',
+
+        "@media (max-width: 768px)": {
+            flexDirection: 'column',
+            alignItems: 'stretch',
+        },
+    },
+    buttonContainer: {
+        display: 'flex',
+
+        "@media (max-width: 768px)": {
+            justifyContent: 'left',
+        },
+    },
 })
 export const PanelRight = () => {
    const style = useStyle()
@@ -52,7 +91,7 @@ export const PanelRight = () => {
    return <div className={style.container}>
        <div className={style.form}>
            <h2 className={style.title}>获取文件</h2>
-            <div>
+            <div className={style.inputContainer}>
                <input
                    type="text"
                    className={style.code}
@@ -60,7 +99,9 @@ export const PanelRight = () => {
                    value={code}
                    onChange={onCodeChange}
                />
-                <UButton style={{marginLeft: '10px'}} onClick={onFetchFile}>获取文件</UButton>
+                <div className={style.buttonContainer}>
+                    <UButton onClick={onFetchFile}>获取文件</UButton>
+                </div>
            </div>
        </div>
    </div>
--- a/frontend/src/page/share/share.tsx
+++ b/frontend/src/page/share/share.tsx
@@ -13,6 +13,12 @@ const useStyle = createUseStyles({
        height: "100vh",
        display: "grid",
        gridTemplateColumns: "40% 20% 40%",
+
+        "@media (max-width: 768px)": {
+            gridTemplateColumns: "100%",
+            gridTemplateRows: "auto auto",
+            overflowY: "auto",
+        },
    },
 })
Author	SHA1	Message	Date
loveuer	909a016a44	docs: add comprehensive README Some checks failed / build ushare (push) Has been cancelled Details / clean (push) Has been cancelled Details - Add project introduction and features - Add quick start guide (development and production) - Add configuration documentation - Add usage instructions - Add mobile support section - Add development guide and directory structure	2026-01-18 17:52:39 +08:00
loveuer	96fe642175	fix: correct pnpm setup in GitHub Actions - Use pnpm/action-setup@v2 instead of npm install -g - Add proper pnpm cache configuration - Fix 'Unable to locate executable file: pnpm' error	2026-01-18 17:35:34 +08:00
loveuer	d38fa7a507	feat: optimize mobile responsive layout for share page - Add responsive design for mobile devices (≤768px) - Switch from horizontal to vertical layout on mobile - Hide middle divider panel on mobile - Optimize button sizes for mobile touch interaction - Improve input field and button alignment on mobile	2026-01-18 17:12:07 +08:00
loveuer	8a063d15d9	ci: add GitHub Actions workflow for releasing binaries Some checks failed / build ushare (push) Has been cancelled Details / clean (push) Has been cancelled Details - Add .github/workflows/release.yml - Build binaries for multiple platforms (linux/amd64, linux/arm64, darwin/amd64, darwin/arm64, windows/amd64) - Embed frontend into binary - Generate SHA256 checksums for each binary - Automatically release on tag push	2026-01-18 14:04:36 +08:00