Skip to content

Latest commit

 

History

History
197 lines (129 loc) · 7.5 KB

README_zh.md

File metadata and controls

197 lines (129 loc) · 7.5 KB
Raw

Saasfly

GitHub Actions工作流状态 GitHub许可证 Discord Saasfly English

一个易于使用、企业级的Next.js样板。

您不再需要购买模板; Saasfly提供了一个完整的开源解决方案,用于快速轻松地构建SaaS应用程序。

Nextify 提供完整的企业SaaS解决方案。如果您有兴趣讨论您的项目,或者您只是想与我们交谈,请随时与我们联系contact@nextify.ltd。

❤️ 我们为非营利组织提供免费的技术支持和部署服务。

🙌 从我们的开源项目中获得的所有利润将完全用于支持开源计划和慈善事业。

⚡ 在线演示

亲自试一试吧!

演示服务器1(位置:美国华盛顿): https://show.saasfly.io

演示服务器2(位置:日本东京): https://demo.saasfly.io

查看更多文档请访问 https://document.saasfly.io

🌟 Star历史

Star History Chart

🚀 入门指南

🖱 一键模板

Deploy with Vercel

📋 前提条件

开始之前,请确保您已安装以下内容:

  1. Bun & Node.js & Git

    1. Linux
      curl -sL https://gist.github.com/tianzx/874662fb204d32390bc2f2e9e4d2df0a/raw -o ~/downloaded_script.sh && chmod +x ~/downloaded_script.sh && source ~/downloaded_script.sh
    1. MacOS
      /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"  
  brew install git
  brew install oven-sh/bun/bun
  brew install nvm

  2. PostgreSQL

    1. 您可以使用Vercel Postgres或本地PostgreSQL服务器(在.env.local中添加POSTGRES_URL环境变量) 
         POSTGRES_URL = ''

安装

要开始使用此样板,我们提供两个选项:

  1. 使用bun create命令(🌟强烈推荐🌟):
bun create saasfly
  1. 手动克隆存储库:
git clone https://github.com/saasfly/saasfly.git
cd saasfly 
bun install

设置

按照以下步骤设置您的项目:

  1. 设置环境变量:
cp .env.example .env.local 
// (在运行此命令之前,您必须准备一个数据库)
bun db:push
  1. 运行开发服务器:
bun run dev:web
  1. 在浏览器中打开http://localhost:3000查看结果。

🥺 项目路线图

  1. 管理仪表板页面(处于alpha阶段!!!) 2. 目前仅提供静态页面,我们计划与无头架构CMS集成 3. 您可以提供管理员账号,在.env.local中更改ADMIN_EMAIL="admin@saasfly.io,root@saasfly.io",然后访问host:port/admin/dashboard 4. 基于安全考虑,我们暂时不提供在线演示。
  2. 多语言READEME
  3. TODO

⭐ 特性

🐭 框架

  • Next.js - React 网络框架 (使用App Directory)
  • NextAuth.js - 用于Next.js的身份验证
  • Kysely - 用于TypeScript的类型安全SQL查询构建器
  • Prisma - 用于Node.js和TypeScript的下一代ORM,用作架构管理工具
  • React-email - 一个React渲染器,用于使用React组件创建漂亮的电子邮件

🐮 平台

  • Vercel – 轻松部署您的Next.js应用
  • Stripe – 面向互联网企业的支付处理
  • Resend – 面向开发人员的电子邮件营销平台

🐯 企业功能

  • i18n - 对国际化的支持
  • SEO - 搜索引擎优化
  • MonoRepo - Monorepo以更好地管理代码
  • T3 Env - 轻松管理您的环境变量

🐰 数据获取

  • trpc – 轻松创建端到端类型安全API
  • tanstack/react-query – 在React中用于获取、缓存和更新异步数据的钩子

🐲 全局状态管理

  • Zustand – 适用于React的小型、快速且可扩展的状态管理

🐒 UI

  • Tailwind CSS – 用于快速UI开发的实用程序优先CSS框架
  • Shadcn/ui – 使用Radix UI和Tailwind CSS构建的可重用组件
  • Framer Motion – 适用于React的动画库,可轻松为组件添加动画
  • Lucide – 简单美观、像素完美的图标
  • next/font – 优化自定义字体并删除外部网络请求以提高性能

🐴 代码质量

  • TypeScript – 端到端类型安全的静态类型检查器
  • Prettier – 用于一致代码风格的固执的代码格式化程序
  • ESLint – 适用于Next.js和TypeScript的可插拔linter
  • Husky – 轻松使用Git钩子

🐑 性能

  • Vercel Analytics – 用于Next.js应用的实时性能指标
  • bun.sh – npm的替代品,用于更快、更可靠的包管理

🐘 数据库

  • PostgreSQL – 世界上最先进的开源数据库

📦 应用和软件包

  • web: 主要的Next.js应用程序
  • ui: 共享UI组件
  • db: 数据库模式和工具
  • auth: 身份验证实用程序
  • email: 电子邮件模板和实用程序

📜 许可证

本项目采用MIT许可证。有关更多信息,请参阅LICENSE文件。

🙏 致谢

本项目的灵感来自shadcn的Taxonomy和t3-oss的create-t3-turbo。