MCPcopy Index your code
hub / github.com/JOYCEQL/magic-resume

github.com/JOYCEQL/magic-resume @v2.0.6 sqlite

repository ↗ · DeepWiki ↗ · release v2.0.6 ↗
694 symbols 2,098 edges 294 files 0 documented · 0%
README

✨ Magic Resume ✨

License TanStack Start Framer Motion

Magic Resume | Trendshift

简体中文 | English

Magic Resume 是一个现代化的在线简历编辑器,让创建专业简历变得简单有趣。基于 TanStack Start 和 Motion 构建,支持实时预览和自定义主题。

📸 项目截图

85_1x_shots_so

✨ 特性

  • 🚀 基于 TanStack Start 构建
  • 💫 流畅的动画效果 (Motion)
  • 🎨 自定义主题支持
  • 🌙 深色模式
  • 📤 导出为 PDF
  • 🔄 实时预览
  • 💾 自动保存
  • 🔒 硬盘级存储

🛠️ 技术栈

  • TanStack Start
  • TypeScript
  • Motion
  • Tiptap
  • Tailwind CSS
  • Zustand
  • Shadcn/ui
  • Lucide Icons

🚀 快速开始

  1. 克隆项目
git clone git@github.com:JOYCEQL/magic-resume.git
cd magic-resume
  1. 安装依赖
pnpm install
  1. 启动开发服务器
pnpm dev
  1. 打开浏览器访问 http://localhost:3000

📦 构建打包

pnpm build

🐳 Docker 部署

Docker Compose

  1. 确保你已经安装了 Docker 和 Docker Compose

  2. 在项目根目录运行:

docker compose up -d

这将会:

  • 自动构建应用镜像
  • 在后台启动容器

📝 开源协议与商业授权

本项目源代码基于 Apache 2.0 协议开源,但附带严格的商业使用限制

  • 个人免费:仅限个人非商业目的(如个人学习交流、制作个人简历)免费使用。
  • 商用需授权:严禁未经授权的商业化使用。任何组织或个人,若将其作为服务(SaaS/PaaS等)向公众提供以获取利益,或作为企业商业运营使用,或进行二次商业化开发,无论是否修改源代码,均须获取商业授权

详情请查看 LICENSE 文件。

🗺️ 路线图

  • [x] AI 辅助编写
  • [x] 多语言支持
  • [ ] 支持更多简历模板
  • [ ] 更多格式导出
  • [x] 自定义模型
  • [x] 自动一页纸
  • [ ] 导入 PDF, Markdown 等
  • [ ] 在线简历托管

📈 Star History

Star History Chart

📞 联系方式

可以通过以下方式关注最新动态:

  • 作者:SiYue
  • X: @GuangzhouY81070
  • Discord: 欢迎加入群组 https://discord.gg/9mWgZrW3VN
  • 邮箱:18806723365@163.com

  • 项目主页:https://github.com/JOYCEQL/magic-resume

🌟 支持项目

图片描述

❤️ 赞助名单

Sponsors

如果您赞助了本项目,但没展示在这里,请联系我。

<a href="https://github.com/yj147">
  <img src="https://github.com/yj147.png?size=40" width="40" height="40" alt="@yj147" />
</a>
<a href="https://github.com/someone1128">
  <img src="https://github.com/someone1128.png?size=40" width="40" height="40" alt="@someone1128" />
</a>

Extension points exported contracts — how you extend this code

Register (Interface)
(no doc)
src/router.tsx
Window (Interface)
(no doc)
src/types/global.d.ts
TemplateContextProps (Interface)
(no doc)
src/components/templates/TemplateContext.tsx
ResumeMarkdownOptions (Interface)
(no doc)
src/utils/markdown.ts
TemplateSnapshotManifest (Interface)
(no doc)
src/lib/templatePreview.ts
AIConfigState (Interface)
(no doc)
src/store/useAIConfigStore.ts
MenuItem (Interface)
(no doc)
src/app/app/dashboard/client.tsx
GrammarError (Interface)
(no doc)
src/hooks/useGrammarCheck.ts

Core symbols most depended-on inside this repo

cn
called by 349
src/lib/utils.ts
useTranslations
called by 55
src/i18n/compat/client.tsx
normalizeRichTextContent
called by 54
src/lib/richText.ts
useLocale
called by 53
src/i18n/compat/client.tsx
formatDateString
called by 38
src/lib/utils.ts
normalizeText
called by 23
src/utils/markdown.ts
toString
called by 23
src/app/app/dashboard/resumes/utils.ts
getCustomFieldDisplayText
called by 19
src/lib/customField.ts

Shape

Function 518
Interface 173
Class 2
Method 1

Languages

TypeScript100%

Modules by API surface

src/utils/markdown.ts17 symbols
src/types/resume.ts16 symbols
src/components/shared/PhotoConfigDrawer.tsx16 symbols
src/components/shared/rich-editor/RichEditor.tsx15 symbols
src/utils/export.ts11 symbols
src/components/editor/basic/BasicPanel.tsx11 symbols
src/app/app/dashboard/resumes/ResumeWorkbench.tsx9 symbols
scripts/generate-template-snapshots.ts9 symbols
src/lib/templatePreview.ts8 symbols
src/components/ui/unified-date-range-input.tsx8 symbols
src/components/shared/GithubContribution.tsx8 symbols
src/lib/richText.ts7 symbols

Dependencies from manifests, versioned

@google/generative-ai0.24.1 · 1×
@heroui/checkbox2.3.30 · 1×
@heroui/date-input2.3.30 · 1×
@heroui/react2.8.8 · 1×
@heroui/theme2.4.26 · 1×
@internationalized/date3.10.1 · 1×
@radix-ui/react-accordion1.2.2 · 1×
@radix-ui/react-alert-dialog1.1.2 · 1×
@radix-ui/react-dialog1.1.2 · 1×
@radix-ui/react-dropdown-menu2.1.2 · 1×
@radix-ui/react-hover-card1.1.4 · 1×
@radix-ui/react-label2.1.0 · 1×

For agents

$ claude mcp add magic-resume \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact