create-seekdb-app

🚀 快速创建集成 SeekDB 的全栈应用脚手架工具

类似于 create-react-app 和 create-next-app，create-seekdb-app 可以帮助你快速搭建集成了 SeekDB 数据库的项目。

📖 Language: English | 中文

特性

• 🎯 多种模板选择 - 支持 Next.js、Electron、Express、Fastify、Flask、FastAPI 等
• 🔥 开箱即用 - 预配置好的 SeekDB 集成（JavaScript 使用 seekdb-js，Python 使用 pyseekdb）
• 🚀 快速启动 - 一条命令即可创建完整的项目结构
• 📦 从 GitHub 克隆 - 直接从官方模板仓库克隆最新代码
• 🛠️ TypeScript 支持 - 所有 JavaScript/TypeScript 模板都包含完整的类型定义

使用方法

使用 npx (推荐)

npx create-seekdb-app my-app

使用 pnpm

pnpm create seekdb-app my-app

使用 npm

npm create seekdb-app my-app

使用 yarn

yarn create seekdb-app my-app

可用模板

Web 框架

• Next.js + seekdb - Next.js 全栈 Web 应用
  • GitHub: nextjs-seekdb-template
  • 技术栈: TypeScript, React, seekdb-js
  • 包管理器: pnpm

桌面应用

• Electron + Next.js + seekdb - Electron 桌面应用
  • GitHub: electron-nextjs-seekdb-template
  • 技术栈: TypeScript, React, Electron, seekdb-js
  • 包管理器: pnpm

后端 API (Node.js)

• Express + seekdb - Express.js 后端 API

  • GitHub: express-seekdb-template
  • 技术栈: TypeScript, Express, seekdb-js
  • 包管理器: pnpm

• Fastify + seekdb - Fastify 后端 API

  • GitHub: fastify-seekdb-template
  • 技术栈: TypeScript, Fastify, seekdb-js
  • 包管理器: pnpm

后端 API (Python)

• Flask + pyseekdb - Flask Web 应用

  • GitHub: flask-seekdb-template
  • 技术栈: Python, Flask, pyseekdb
  • 包管理器: poetry

• FastAPI + pyseekdb - FastAPI 后端 API

  • GitHub: fastapi-seekdb-template
  • 技术栈: Python, FastAPI, pyseekdb
  • 包管理器: poetry

命令行选项

create-seekdb-app [project-name] [options]
create-seekdb-app list                    # 列出所有可用模板

选项:
  -t, --template <template>  指定模板 (nextjs, electron-nextjs, express, fastify, flask, fastapi)
  --skip-install            跳过依赖安装
  -h, --help                显示帮助信息
  -V, --version             显示版本号

列出所有模板

# 查看所有可用的模板
npx create-seekdb-app list

# 或使用简写
npx create-seekdb-app ls

这会显示所有可用的模板，包括：

• 模板名称和描述
• GitHub 仓库链接
• 使用的编程语言
• 推荐的包管理器

示例

交互式创建

npx create-seekdb-app

然后根据提示选择项目名称和模板。

使用命令行参数

# 创建 Next.js 项目
npx create-seekdb-app my-nextjs-app --template nextjs

# 创建 Electron 项目
npx create-seekdb-app my-desktop-app --template electron-nextjs

# 创建 Express API
npx create-seekdb-app my-api --template express

# 创建 FastAPI 项目
npx create-seekdb-app my-python-api --template fastapi

# 跳过依赖安装
npx create-seekdb-app my-app --skip-install

# 列出所有可用模板
npx create-seekdb-app list

开发

安装依赖

pnpm install

本地开发测试

# 快速测试（推荐）
pnpm dev test-app --template nextjs --skip-install

# 运行自动化测试脚本
./test-local.sh

# 查看完整的测试指南
# 详见 DEVELOPMENT.md 和 TESTING_CHEATSHEET.md

构建

pnpm build

发布

# 详见 PUBLISHING.md
pnpm publish

项目结构

create-seekdb-app/
├── src/
│   ├── bin/
│   │   └── cli.ts          # CLI 入口
│   ├── create-project.ts   # 项目创建逻辑
│   ├── index.ts            # 主入口
│   ├── prompts.ts          # 交互式提示
│   ├── templates.ts        # 模板配置
│   └── utils.ts            # 工具函数
├── package.json
├── tsconfig.json
└── README.md

技术栈

• TypeScript - 类型安全
• Commander.js - CLI 框架
• Prompts - 交互式命令行
• Chalk - 终端样式
• Ora - 加载动画
• simple-git - Git 操作
• fs-extra - 文件系统操作

许可证

MIT

相关链接

• SeekDB 官网
• seekdb-js
• pyseekdb

📚 文档

• 📖 README.md - 项目主文档
• 🚀 QUICKSTART.md - 快速入门指南
• 💡 EXAMPLES.md - 详细使用示例
• 🛠️ DEVELOPMENT.md - 本地开发测试指南
• ⚡ TESTING_CHEATSHEET.md - 快速测试命令参考
• 📝 TEMPLATE_GUIDE.md - 模板开发指南
• 🤝 CONTRIBUTING.md - 贡献指南
• 📦 PUBLISHING.md - npm 发布指南
• 📋 CHANGELOG.md - 版本变更记录
• 📄 PROJECT_SUMMARY.md - 项目改造总结

贡献

欢迎提交 Issue 和 Pull Request！

支持

如有问题，请在 GitHub Issues 提出。