Skip to content

快速开始

请按照以下步骤设置您的开发环境。

克隆仓库

将 NuxSaaS 仓库克隆到您的本地计算机:

bash
git clone https://github.com/NuxSaaS/NuxSaaS.git
cd NuxSaaS

使用 Node.js v22 LTS

使用 nvm 安装 Node.js v22 LTS:

bash
nvm use

此命令会读取 .nvmrc 文件并切换到指定的 Node.js 版本 (v22 LTS)。

安装依赖

使用 npm 安装项目依赖项,或者使用您喜欢的任何包管理器:

bash
npm install

设置环境变量

复制示例环境文件并配置您的本地设置:

bash
cp .env.example .env

您需要编辑 .env 文件以添加数据库凭据、API 密钥(例如 Stripe、Resend)以及其他必要的配置。

bash
# 描述: .env 文件示例
NUXT_NITRO_PRESET=node-server # node-server 或 cloudflare-module

# Cloudflare Hyperdrive ID,使用 cloudflare-module 时必需
NUXT_CF_HYPERDRIVE_ID=cloudflare-hyperdrive-id

# App
NUXT_APP_URL=http://localhost:3000 # Base URL of your app
NUXT_APP_NAME=NuxSaaS
NUXT_APP_ENV=development
NUXT_APP_NOTIFY_EMAIL="[email protected]"
NUXT_APP_CONTACT_EMAIL="[email protected]"
NUXT_APP_REPO=https://github.com/NuxSaaS/NuxSaaS

NUXT_BETTER_AUTH_SECRET='' # Secret key for JWT

# 数据库,使用 node-server preset 时必需
# 您需要创建一个名为 nuxsaas 或您想要的其他名称的数据库
NUXT_DATABASE_URL=postgres://postgres:@localhost:5432/nuxsaas 
# Redis,使用 node-server preset 时必需
NUXT_REDIS_URL=redis://localhost:6379

# GitHub
NUXT_GH_CLIENT_ID=your-github-client-id
NUXT_GH_CLIENT_SECRET=your-github-client-secret

# Google
NUXT_GOOGLE_CLIENT_ID=your-google-client-id
NUXT_GOOGLE_CLIENT_SECRET=your-google-client-secret

# Resend
NUXT_RESEND_API_KEY=your-resend-api-key

# Stripe
NUXT_STRIPE_SECRET_KEY=your-stripe-secret-key
NUXT_STRIPE_WEBHOOK_SECRET=your-stripe-webhook-key
NUXT_STRIPE_PRICE_ID_PRO_MONTH=your-stripe-price-id-pro-month
NUXT_STRIPE_PRICE_ID_PRO_YEAR=your-stripe-price-id-pro-year

生成并应用数据库迁移

根据您的模型生成数据库模式并应用迁移:

bash
npm run db:generate
npm run db:migrate

启动开发服务器

bash
npm run dev

您的应用程序现在应该在本地运行,通常在 http://localhost:3000.