Logo
RavenSaaS Docs

快速开始

R
🚀 快速开始
感谢选择 RavenSaaS,这是一个现代化的 NextJS SaaS 开发框架,专注于帮助开发者快速构建 AI 驱动的 SaaS 应用。
📦

获取 RavenSaaS 代码

获取项目源码并开始您的开发之旅

1

在 RavenSaaS 官网下单购买

2

支付完成后,进入订单中心

💡选择订单进行激活。
  • 在订单中心,点击“激活订单”,输入您的 GitHub 用户名,点击“激活”。激活订单
  • 激活成功后,您将收到一个 GitHub 仓库邀请,请在 GitHub 中接受邀请。
  • 3

    在订单中心,点击"激活订单",输入您的 GitHub 用户名,点击"激活"

    激活订单
    4

    激活成功后,您将收到一个 GitHub 仓库邀请

    请在 GitHub 中接受邀请。

    拉取项目代码

    1. 进入 RavenSaaS 代码仓库(如果您还未加入仓库,打开将显示 404)
    2. 选择 git clone 方式,或直接下载源码到本地
      Terminal
      1git clone https://github.com/your-username/ravensaas-template.git my-saas-project

    安装项目

    1. 进入项目根目录
      Terminal
      1cd my-saas-project
    2. 安装项目依赖
      Terminal
      1pnpm install

    开发调试

    1. 复制环境变量配置文件
      Terminal
      1cp .env.example .env.development
    2. 启动开发服务器
      Terminal
      1pnpm dev
      激活订单
    3. 本地预览

      在浏览器打开 http://localhost:3000 预览您的项目激活订单

    定制化

    修改网站配色

    1. 选择一个 shadcn 主题调试器
    2. 为您的项目创建主题配色方案
      激活订单
    3. 复制主题样式并粘贴到项目文件:src/app/theme.css
      激活订单
    4. 重新进入项目预览页面查看您的定制主题
      激活订单

    修改落地页内容

    1. 打开落地页内容文件,使用 AI 辅助生成新的落地页内容

      提示词示例:

      Terminal
      1I want to build a landing page for my product named "Flux AI Image Generator", please update the landing page json file, content reference @Web @https://www.flux.ai/
      激活订单
    2. 应用 AI 生成的新落地页内容,手动调整并预览新落地页
      激活订单
    3. 继续调整 src/i18n/messages 下的其他 json 文件,使网页内容符合您的项目

    修改多语言文案

    在 src/i18n/messages 目录下,通过 [locale].json 文件配置页面内容。默认支持中文和英文,在 src/i18n/messages/ 目录下可以看到 en.json 和 zh.json 文件。项目发布前,请修改为符合您项目的文案。

    您可以使用 AI 辅助生成内容:

    提示词示例:

    Terminal
    1rewrite this json file with new content for my new project "Game AI", which is an AI Image Generator, with keywords "game ai, ai image generator"

    修改网站协议

    网站上线前,请根据您网站提供的服务,更新 src/app/privacy 和 src/app/terms 目录下的网站协议。

    1. 更新隐私政策

      在 Cursor 中,通过提示词生成新的隐私政策内容。

      提示词示例:

      Terminal
      1update privacy-policy according to landing page content @en.json with brand name "RavenSaaS", domain "ravensaas.io", contact email is "support@ravensaas.io"

      文件位置:src/app/privacy/page.mdx

    2. 更新服务条款

      在 Cursor 中,通过提示词生成新的服务条款内容。

      提示词示例:

      Terminal
      1update terms-of-service according to landing page content @en.json with brand name "RavenSaaS", domain "ravensaas.io", contact email is "support@ravensaas.io"

      文件位置:src/app/terms/page.mdx

    修改网站 Logo 和 Icon

    请为您的网站生成 Logo 和 Icon 图片,分别替换 public/logo.png 和 public/favicon.ico 两个文件。

    修改网站地图

    根据您网站线上运行的实际域名和希望搜索引擎索引的页面路径,修改网站地图。

    文件位置:public/sitemap.xml,默认内容如下:

    Terminal
    1<?xml version='1.0' encoding='utf-8' standalone='yes'?>
    2<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
    3  <url>
    4    <loc>https://ravensaas.io/</loc>
    5    <lastmod>2024-12-24T10:00:00+00:00</lastmod>
    6  </url>
    7</urlset>

    修改配置内容

    根据实际需求,修改配置文件中的环境变量,以启用数据存储 / 登录 / 数据分析 / 支付等功能

    开发环境配置文件:.env.development,生产环境配置文件:.env.production

    建议优先配置 DATABASE_URL 值,填入一个 Postgres 数据库的连接地址(包括 Supabase、Neon 等 Serverless 数据库)。

    Terminal
    1# 站点名
    2NEXT_PUBLIC_BRAND_NAME = 
    3
    4# 开发环境环境变量
    5NEXT_PUBLIC_WEB_URL = "http://localhost:3000"
    6
    7#NextAuth 配置
    8NEXTAUTH_SECRET = 6UF9ydNcGE3i03714dZZqQT4BBuTT+gRjTMTFzbNda0=
    9
    10
    11# Google OAuth 配置
    12AUTH_GOOGLE_ID = 
    13NEXT_PUBLIC_AUTH_GOOGLE_ID = 
    14AUTH_GOOGLE_SECRET = 
    15NEXT_PUBLIC_AUTH_GOOGLE_ENABLED = 
    16NEXT_PUBLIC_AUTH_GOOGLE_ONE_TAP_ENABLED = 
    17
    18# GitHub OAuth 配置
    19AUTH_GITHUB_ID = 
    20AUTH_GITHUB_SECRET = 
    21NEXT_PUBLIC_AUTH_GITHUB_ENABLED = 
    22
    23# 数据库配置 (如果使用)
    24SUPABASE_URL = 
    25NEXT_PUBLIC_SUPABASE_URL = 
    26SUPABASE_ANON_KEY = 
    27NEXT_PUBLIC_SUPABASE_ANON_KEY = 
    28
    29#谷歌统计
    30NEXT_PUBLIC_GOOGLE_ANALYTICS_ID = 
    31
    32# 配置云存储
    33STORAGE_ENDPOINT = ""
    34STORAGE_REGION = ""
    35STORAGE_ACCESS_KEY =
    36STORAGE_SECRET_KEY =
    37STORAGE_BUCKET =
    38STORAGE_DOMAIN =
    39
    40# stripe 支付
    41STRIPE_PUBLIC_KEY =
    42STRIPE_PRIVATE_KEY =
    43NEXT_PUBLIC_PAY_SUCCESS_URL = "http://localhost:3000/my-orders"
    44NEXT_PUBLIC_PAY_FAIL_URL = "http://localhost:3000/#pricing"
    45NEXT_PUBLIC_PAY_CANCEL_URL = "http://localhost:3000/#pricing"
    46
    47# 管理员邮箱
    48ADMIN_EMAILS =
    49
    50# AI
    51# openai
    52OPENAI_BASE_URL =
    53OPENAI_API_KEY =
    54
    55# Replicate
    56REPLICATE_API_TOKEN = 

    上线前检查

    项目发布上线前,请检查以下内容是否已根据实际情况修改。

    • ✅ 修改网站配色。src/app/theme.css
    • ✅ 修改落地页内容。src/i18n/pages/landing/*.json
    • ✅ 修改多语言文案。src/i18n/messages/*.json
    • ✅ 修改网站协议。src/app/privacy/page.mdx,src/app/terms/page.mdx
    • ✅ 修改网站 Logo 和 Icon。public/logo.png,public/favicon.ico
    • ✅ 修改网站地图。public/sitemap.xml
    • ✅ 修改配置内容。.env.development,.env.production

    部署上线

    1. 创建 GitHub 仓库
      请务必选择私有仓库,不要公开发布 RavenSaaS 代码,拒绝盗版。
    2. 提交修改后的项目代码到您的项目 GitHub 仓库
      Terminal
      1git remote set-url origin https://github.com/your-username/your-project-name.git
      2git add .
      3git commit -m "update landing page"
      4git push origin main
    3. 在 Vercel 控制台创建新项目,导入代码仓库,一键部署
    4. 等待构建完成,您可以在 Vercel 控制台看到您的项目
    5. 打开域名访问您的项目

    Last updated on 2025年1月5日