โ End-to-end Type Safety - Type your backend functions and get inferred types on the front-end automatically, without the need to install or configure any third-party libraries. Oh, and type-safe Links, too!
๐ค Jobs - Run cron jobs in the background or set up queues simply by defining a function in the config file.
๐ One-command Deploy - Easily deploy your DB, Server, & Client with one command to Railway or Fly.io via the CLI. Or deploy manually to any other hosting service of your choice.
You also get access to Wasp's diverse, helpful community if you get stuck or need help.
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!
One-click Deploy on Railway
Prefer to start from a live deployment? The Open SaaS Railway template deploys the database, server, and client to Railway in one click. Then eject it into your own GitHub repo, clone it, and develop locally โ every push to main redeploys automatically. See the deployment guide for details.
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!):
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:
TypeScript support with @typescript-eslint
React and React Hooks linting
Sensible defaults tuned for a SaaS application
Automatic support for CommonJS (.cjs), ES Modules (.mjs), and TypeScript files
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.
