NextSaas
NextSaas
介绍快速开始配置数据库身份验证邮件国际化 (i18n)支付文件存储部署更新日志

快速开始

如何在本地安装和运行 NextSaas。

要开始使用 NextSaas,您需要设置开发环境。我们推荐使用 Bun 以获得最佳体验,但 Node.js + npm/pnpm/yarn 也可以正常工作。

先决条件

  • Node.js: v20 或更高版本。
  • 包管理器: Bun (推荐) 或 npm/pnpm/yarn。
  • Git: 用于版本控制。
  • 编辑器: VS Code (推荐)。

安装

  1. 克隆代码仓库:

    git clone https://github.com/your-username/next-saas.git
    cd next-saas
  2. 安装依赖:

    我们使用 bun 进行快速安装,但标准的 npm 也可以。

    bun install
    # 或者
    npm install

环境变量设置

  1. 复制示例环境文件:

    cp .env.simple .env
  2. 配置基本变量:

    打开 .env 并设置运行应用所需的最小变量。对于快速启动,您只需要:

    • NEXT_PUBLIC_HOST (例如 http://localhost:3000)
    • DATABASE_URL (PostgreSQL 连接字符串)
    • BETTER_AUTH_SECRET (生成一个: openssl rand -base64 32)

    [!TIP] 我们将在后续章节详细介绍 Auth、Stripe 和 Email 的配置。

本地运行

启动开发服务器:

bun dev
# 或者
npm run dev

访问 http://localhost:3000 查看您的应用。

项目结构

以下是顶级结构的快速概览:

  • src/app: Next.js App Router 页面和 API 路由。
  • src/components: 可复用的 UI 组件。
  • src/lib: 工具函数和第三方集成 (Stripe, GitHub 等)。
  • src/db: 数据库 Schema 和 Drizzle ORM 配置。
  • content/docs: 本文挡站点的 Markdown 内容。
  • messages: next-intl 翻译文件 (en, zh-CN)。

介绍

欢迎阅读 NextSaas 文档。

配置

自定义您的 SaaS 品牌和设置。

On this page

先决条件安装环境变量设置本地运行项目结构