Skip to content

Panda-995/KOLFlow

Repository files navigation

KOLFlow

达人商单流管理系统
KOL Business Collaboration Management System

轻松管理每一笔合作,让商单管理更高效
Efficient business collaboration tracking for KOLs

FeaturesGetting StartedDeploymentAPI DocsTech Stack

Node.js React License


Features | 功能特性

Feature 功能
📊 Dashboard 📊 仪表盘
📦 Order Management 📦 商单管理
✅ Todo & Calendar ✅ 待办/日历
💰 Billing 💰 账单管理
🏢 Brand Management 🏢 品牌管理
📈 Analytics 📈 数据统计
🔐 API Key Management 🔐 API Key 管理
🎨 Themes 🎨 主题外观

Data Linkage | 数据联动

Action 操作 Effect 效果
Create Order 创建商单 Auto-create Todo 自动创建待办
Complete Order 商单完成 Auto-create Bill 自动创建账单
Delete Brand 删除品牌 Clear brand info 品牌信息置空
Complete All Todos 待办全部完成 Mark order complete 关联商单标记完成

Getting Started | 快速开始

Requirements | 环境要求

  • Node.js >= 20.19.0 or >= 22.12.0
  • npm >= 9

Note: Due to @vitejs/plugin-react@5.x, Node.js version must be >= 20.19.0.

Installation | 安装

git clone https://github.com/Panda-995/KOLFlow.git
cd KOLFlow
npm install

Configuration | 配置

Create .env file:

NODE_ENV=production
PORT=3000
JWT_SECRET=your-secret-key-here
INVITE_CODE=your-invite-code

Run | 运行

# Development | 开发模式
npm run dev

# Production | 生产构建
npm run build
npm run preview

First Use | 首次使用

  1. Visit http://localhost:3000
  2. Click "注册账号" (Register)
  3. Enter email, password, and invite code

Deployment | 部署

Docker (Recommended) | Docker 部署(推荐)

支持多架构镜像:amd64 (x86_64) 和 arm64 (Apple Silicon, 树莓派等)

# 拉取并启动(自动选择对应架构)
docker-compose up -d

# 或手动指定镜像
docker run -d -p 3000:3000 \
  -e JWT_SECRET=your-secret \
  -e INVITE_CODE=your-code \
  ghcr.io/panda-995/kolflow:latest

镜像标签:

Tag 说明
latest 最新版(多架构)
arm ARM64 架构专用
arm64 ARM64 架构专用
linux/amd64 x86_64 架构

Set environment variables | 设置环境变量:

export JWT_SECRET=your-secret-key
export INVITE_CODE=your-invite-code
docker-compose up -d

API Docs | API 文档

Authentication | 认证

# Register | 注册
POST /api/auth/register
Body: { email, password, inviteCode }

# Login | 登录
POST /api/auth/login
Body: { email, password }

# Verify Token | 验证 Token
POST /api/auth/verify
Headers: Authorization: Bearer <token>

External API | 外部 API

GET /api/external/orders?token=<API_KEY>
GET /api/external/statistics?token=<API_KEY>

Tech Stack | 技术栈

Category 分类 Tech 技术
Frontend 前端 React 19, TypeScript, Tailwind CSS
Backend 后端 Express, better-sqlite3
State 状态 Zustand
Charts 图表 Recharts
Security 安全 bcrypt, JWT, helmet
Deployment 部署 Docker, Vercel

License | 许可证

MIT License - Commercial use allowed, but must retain author attribution.

详细许可证内容请查看 LICENSE 文件。


Author | 作者

Panda-995


Support | 支持

如果这个项目对你有帮助,欢迎赞赏支持!

Tutorial | 使用教程

值得买详细教程:KOLFlow 达人商单管理系统使用教程

赞赏码
赞赏码
小程序码
小程序码

Made with ❤️ by Panda-995

About

KOLFlow 是一款专为 KOL/达人设计的商单管理系统,帮助您轻松管理每一笔商业合作。 从商单创建、进度跟踪到财务结算,让繁琐的商单管理变得简单高效。

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages