Skip to content

bevisbao/Weeklyreport

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Weeklyreport - AI 驱动的专业周报生成工具

License Version

把一周的忙,写成领导爱看的周报。 3 秒内将工作内容转换为结构化、结果导向的专业周报。

GitHubIssues


📋 项目概述

Weeklyreport 是一个 AI 驱动的周报生成工具,帮助职场人士快速生成结构化、结果导向的周报/月报/绩效自评。

核心价值

  • 快速生成:3 秒内将工作内容转换为专业周报
  • 🎯 结构清晰:AI 自动补齐关键信息
  • 🛡️ 风险管理:自动生成风险说明和依赖项
  • 👥 多岗位支持:6 种岗位模板
  • 🎨 灵活定制:3 种输出风格 × 3 种输出长度
  • 🔒 隐私优先:默认不保存内容

✨ 功能特性

6 种岗位模板

  • 通用周报
  • 产品经理
  • 运营/增长
  • 研发
  • 项目管理
  • 销售支持

3 种输出风格

  • 稳重(专业、保守)
  • 强结果(结果导向)
  • 强协作(团队合作)

3 种输出长度

  • 短(2-3 句话)
  • 中(3-5 句话)
  • 长(5-8 句话)

📁 项目结构

Weeklyreport/
├── app/                          # Next.js App Router
│   ├── page.tsx                 # 首页(3 屏布局)
│   ├── layout.tsx               # 根布局
│   ├── globals.css              # 全局样式
│   ├── generate/
│   │   └── page.tsx             # 生成页(模板、表单、结果)
│   ├── pricing/
│   │   └── page.tsx             # 付费页(套餐对比)
│   └── api/
│       └── generate/
│           └── route.ts         # 生成 API 端点
│
├── components/                   # React 组件
│   └── Button.tsx               # 按钮组件
│
├── lib/                          # 工具函数库
│   ├── openai.ts               # OpenAI 集成
│   ├── analytics.ts            # 埋点系统
│   └── utils.ts                # 工具函数
│
├── types/                        # TypeScript 类型定义
│   └── index.ts                # 类型定义
│
└── prisma/                       # 数据库 Schema
    └── schema.prisma           # Prisma Schema

🛠️ 技术栈

前端

  • Next.js 15 - React 全栈框架
  • React 18 - UI 库
  • TypeScript - 类型安全
  • Tailwind CSS - 样式框架
  • Framer Motion - 动画库
  • Lucide React - 图标库

后端

  • Next.js API Routes - API 路由
  • OpenAI API - AI 文本生成
  • Prisma - ORM 数据库
  • NextAuth.js - 用户认证

🚀 快速开始

前置要求

  • Node.js 18+
  • npm 或 yarn
  • OpenAI API 密钥

安装步骤

  1. 克隆项目
git clone https://github.com/bevisbao/Weeklyreport.git
cd Weeklyreport
  1. 安装依赖
npm install
  1. 配置环境变量
cp .env.example .env.local

编辑 .env.local

NEXT_PUBLIC_OPENAI_API_KEY=your_openai_api_key_here
NEXTAUTH_SECRET=your_nextauth_secret_here
NEXTAUTH_URL=http://localhost:3000
DATABASE_URL=postgresql://user:password@localhost:5432/weeklyreport
  1. 运行开发服务器
npm run dev

打开 http://localhost:3000 查看应用。

  1. 构建生产版本
npm run build
npm start

📖 核心文件说明

app/ - Next.js 应用

  • page.tsx - 首页,包含 3 屏布局(痛点共鸣、价值点、社会证明)
  • generate/page.tsx - 生成页,支持 6 种模板、3 种风格、3 种长度
  • pricing/page.tsx - 付费页,展示 Free/Pro/Pro+ 三档套餐
  • api/generate/route.ts - API 路由,处理周报生成请求
  • layout.tsx - 根布局组件
  • globals.css - 全局样式

components/ - React 组件

  • Button.tsx - 可复用按钮组件(支持多种变体和大小)

lib/ - 工具函数库

  • openai.ts - OpenAI API 集成,处理 AI 生成逻辑
  • analytics.ts - 埋点系统,追踪用户行为
  • utils.ts - 通用工具函数

types/ - TypeScript 类型

  • index.ts - 项目类型定义

prisma/ - 数据库

  • schema.prisma - Prisma 数据库 Schema

🎯 使用示例

输入

本周事项:
- 修复登录 Bug
- 对齐需求
- 推进上线

风险:支付三方回调存在偶发延迟
需要支持:风控同学确认规则变更窗口

输出(AI 生成)

【本周进展】
定位并修复登录失败根因,降低相关工单;完成需求对齐与排期确认,确保按期上线。

【关键结果】
沉淀可执行 PRD/评审结论与排期,降低返工风险;建立上线监控指标口径,为灰度决策提供依据。

【协作与推动】
联动客户端/服务端/数据同学完成方案对齐与资源确认。

【风险与依赖】
三方回调偶发延迟需提前压测与降级预案;依赖风控规则变更窗口确认。

【下周计划】
灰度上线 → 监控核心指标 → 复盘问题并推进全量。

💰 套餐对比

功能 Free Pro Pro+
每日生成次数 3 次/天 不限 不限
岗位模板
输出风格 稳重 ✅ + 冲KPI
输出长度
导出格式 复制 复制 + MD 复制 + MD + Word/PDF
历史记录
绩效自评
价格 ¥0 ¥19/月 ¥39/月

🚢 部署

Vercel 部署(推荐)

npm install -g vercel
vercel

Docker 部署

docker build -t weeklyreport .
docker run -p 3000:3000 -e NEXT_PUBLIC_OPENAI_API_KEY=your_key weeklyreport

🤝 贡献指南

欢迎提交 Issue 和 Pull Request!

提交 Issue

  • 清晰描述问题
  • 提供复现步骤
  • 附加截图或日志

提交 PR

  1. Fork 项目
  2. 创建特性分支 (git checkout -b feature/AmazingFeature)
  3. 提交更改 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 开启 Pull Request

📝 许可证

本项目采用 MIT 许可证


📞 联系方式


⭐ 如果这个项目对你有帮助,请给个 Star!

Made with ❤️ by B.K Team

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors