open-saas README

The project's README from github.com/wasp-lang/open-saas. As one markdown file: README.md.

Welcome to your new SaaS App! 🎉

Open SaaS 2.0 - Free, open-source SaaS starter kit with superpowers | Product Hunt Open SaaS 2.0 - Free, open-source SaaS starter kit with superpowers | Product Hunt

https://github.com/user-attachments/assets/3856276b-23e9-455e-a564-b5f26f4f0e98

You've decided to build a SaaS app with the Open SaaS template. Great choice!

This template is:

  1. fully open-source
  2. completely free to use and distribute
  3. comes with a ton of features out of the box!
  4. ready to work with your favorite AI coding tool or agent (Claude Code, Cursor, Codex, OpenCode, etc.)

🧑‍💻 Check it out in action here: OpenSaaS.sh 📚 Check out the Docs here: Open SaaS Docs

What's inside?

The template itself is built on top of some very powerful tools and frameworks, including:

Because we're using Wasp as the full-stack framework, we can leverage a lot of its features to build our SaaS in record time, including:

You also get access to Wasp's diverse, helpful community if you get stuck or need help.

Getting Started

Simple Instructions

First, to install the latest version of Wasp on macOS, Linux, or Windows with WSL, run the following command:

npm i -g @wasp.sh/wasp-cli

Then, create a new SaaS app with the following command:

wasp new -t saas

This will create a clean copy of the Open SaaS template into a new directory, and you can start building your SaaS app right away!

Detailed Instructions

For everything you need to know about getting started and using this template, check out the Open SaaS Docs.

We've documented everything in great detail, including installation instructions, pulling updates to the template, guides for integrating services, SEO, deployment, and more. 🚀

Getting Help & Providing Feedback

There are two ways to get help or provide feedback (and we try to always respond quickly!):

  1. Open an issue
  2. Wasp Discord -- please direct questions to the #🙋questions forum channel

Development Tools

Code Quality Tools

This repository includes comprehensive code quality tooling to help maintain code standards:

Prettier (Code Formatting)

Prettier is configured for automatic code formatting across all JavaScript, TypeScript, and other supported files.

# Check if files are formatted correctly
npm run prettier:check

# Automatically format all files
npm run prettier:format

ESLint (Code Linting)

ESLint is configured with TypeScript and React support to catch potential bugs and enforce code quality standards.

# Run ESLint to check for issues
npm run lint

# Automatically fix fixable issues
npm run lint:fix

The ESLint configuration includes:

Both Prettier and ESLint checks are automatically run in CI/CD pipelines to ensure code quality.

For information about other development tools used to maintain derived projects (like opensaas.sh and template-test), see tools/README.md.

Contributing

Note that we've tried to get as many of the core features of a SaaS app into this template as possible, but there still might be some missing features or functionality.

We could always use some help tying up loose ends: contributions are welcome! Check out CONTRIBUTING.md for more details.

open-saas (wasp-lang/open-saas)

Searching Database…

16.1K ·GitHub
这是什么?Open SaaS 是一个免费开源的 SaaS 脚手架,基于 Wasp 全栈框架(React、NodeJS、Prisma)构建。一套模板就自带用户认证、支付、邮件、后台任务、落地页、文件上传、管理后台等开箱即用的功能。
这本身是一个框架,还是我可以拿来改的现成应用?它是一个模板,不是框架:你从它生成一个项目,然后在这个代码基础上开发自己的产品。底层依赖 Wasp(一个 React、NodeJS、Prisma 全栈框架),文档和博客部分则用了 Astro 的 Starlight。
怎么上手?先安装 Wasp CLI(macOS、Linux,或通过 WSL 的 Windows),然后运行提供的命令创建一个新的 SaaS 应用——它会把 Open SaaS 模板复制到一个全新的目录,你可以立刻开始开发。
用它之前需要安装或注册什么?需要 Wasp CLI 和 Node.js 环境:前端是 React,后端是 NodeJS,数据库用 Prisma 连接 PostgreSQL。发邮件和支付还需要在 SendGrid 或 Stripe 这类服务商那里注册账号。
在 Windows 上能用吗?有什么坑?Windows 只能通过 WSL 支持,不能原生运行。作者也提到部分 SaaS 功能可能还不完善——这是一个开放模板,欢迎大家贡献代码来补齐。
应用做好之后怎么部署上线?通过 CLI 一条命令就能把数据库、服务端和客户端部署到 Railway 或 Fly.io,也可以手动部署到你自选的其他托管平台。
支持哪些支付服务商?Stripe、Polar.sh 或 Lemon Squeezy——支付流程已经在模板里预置好了,你按自己的产品选一个合适的就行。
除了认证和支付,还自带哪些功能?邮件发送(SendGrid、MailGun 或 SMTP)、AWS S3 文件上传、后台定时任务和队列、统计分析(Plausible 或 Google Analytics)、Playwright 端到端测试,以及一个带函数调用的 OpenAI 示例。
这里的 AI-ready 是什么意思?仓库里附带了定制的 AGENTS.md,以及针对 Claude Code、Cursor、Codex、OpenCode 等 AI 编程工具的插件、技能和规则,让编程助手知道该怎么处理这个代码库。
真的完全免费吗?是的——它基于 MIT 许可证完全开源,可以自由使用和分发,没有任何地方提到付费版本。
Creator
wasp-lang
Size
138.4 MB
Stars
16.1K
Age
2y
Commits · 90 Days