Skip to content

docs: improve README #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
webbrain-one wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve README #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@


<div align="center">
<h1>ProspectKit</h1>
<p>
Expand Down Expand Up @@ -96,7 +98,7 @@ Requires [pnpm](https://pnpm.io/) (enable with `corepack enable` if needed).

```bash
git clone <your-fork-or-repo-url>
cd prospect-kit
cd ProspectKit
pnpm install
```

Expand Down Expand Up @@ -201,7 +203,7 @@ After deployment:
```bash
pnpm dev # Run migrations, then start the Next dev server
pnpm build # Build for production
pnpm start # Start the production server
pnpm start # Start the production server
pnpm lint # Run ESLint
pnpm format # Format the repository
pnpm format:check # Check formatting
Expand All @@ -213,6 +215,7 @@ Database commands:
pnpm db:auto-migrate # Run migrations automatically
pnpm db:generate # Generate migration files from schema changes
pnpm db:migrate # Run migrations manually
pnpm db:pull # Pull schema changes from the database
pnpm db:push # Push schema changes directly to DB
pnpm db:studio # Open Drizzle Studio
pnpm db:check # Check migration/schema consistency
Expand Down Expand Up @@ -347,7 +350,7 @@ ProspectKit 使用一套现代、容易部署的 TypeScript 技术栈：

```bash
git clone <your-fork-or-repo-url>
cd prospect-kit
cd ProspectKit
pnpm install
```

Expand Down Expand Up @@ -454,7 +457,7 @@ npx vercel deploy
```bash
pnpm dev # 运行迁移并启动开发服务器
pnpm build # 生产构建
pnpm start # 启动生产服务
pnpm start # 启动生产服务
pnpm lint # 运行 ESLint
pnpm format # 格式化代码
pnpm db:migrate # 运行数据库迁移
Expand Down