Open SaaS x Railway Template 🐝 🛤

open-saas-v2-launch-1080p.mp4

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

This template is:

1. fully open-source & free to use
2. comes with a ton of features out of the box
3. is pre-configured for instant Railway deployments

Warning

This is a special version of Open SaaS designed for instant Railway deployments.
Do not use Wasp's built-in deploy commands as it will interfere with your Railway setup.

Using this Open SaaS x Railway template

If you haven't already deployed Open SaaS via the Railway template directory, you can do so now:

Initial Deployment

• Click Deploy Now.
• All services are pre-configured for you.
• You'll see the Database, Server, and Client services initialize.

Getting your copy of the template ("ejecting")

• Click on either the Client or Server service to access their configuration.
• Click on the Settings tab.

• Under the Upstream Repo heading, click the Eject button.

• Select your GitHub account and click Eject Service to create a new repo in your account.
• Go to your GitHub repositories, e.g.: https://github.com/<your-user-name>/open-saas-railway
• Clone this repo to your local machine, e.g.: git clone https://github.com/<your-user-name>/open-saas-railway.git

Now you can start building your SaaS app locally. When you push a new commit to main, Railway will automatically deploy your changes! 🚀

Local Development

1️⃣ Install the Wasp CLI:

curl -sSL https://get.wasp.sh/installer.sh | sh

Read the Installation Instructions for more details (prerequisites, installing on Windows).

2️⃣ Start the app by reading the Getting Started Docs.

3️⃣ Although the app will run, you'll need to set up the integrations to get all its functionality. The Open SaaS Docs contain detailed guides on setting up:

• Auth,
• Payments,
• Analytics,
• Email Sending,
• AI-assisted coding,
• and more.

Warning

Remember that this version of Open SaaS is pre-configured for instant Railway deployments. Because of this, the deployment features via the Wasp CLI should not be used. Just simply push to main on your instance's GitHub repo and Railway will automatically deploy your changes!

What's inside?

Project Structure

This template consists of three main dirs:

1. app - Your web app, built with Wasp.
2. e2e-tests - Playwright tests for your Wasp web app.
3. blog - Your blog / docs, built with Astro based on Starlight template.

For more details, check READMEs of each respective directory!

The Tech Stack

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

• 🐝 Wasp - a full-stack React, NodeJS, Prisma framework with superpowers
• 🚀 Astro - Astro's lightweight "Starlight" template for documentation and blog
• 💸 Stripe or Lemon Squeezy (with Polar.sh and Paddle coming soon!) - for products and payments
• 💅 ShadCN UI - for components & styling (plus admin dashboard!)
• 🤖 AI-Ready - full set of Cursor rules & llms-full.txt for ai-assisted coding
• 📈 Plausible or Google Analytics
• 🤖 OpenAI - OpenAI API w/ function calling example
• 📦 AWS S3 - for file uploads
• 📧 SendGrid, MailGun, or SMTP - for email sending
• 🧪 Playwright - end-to-end tests with Playwright

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:

• 🔐 Full-stack Authentication - Email verified + social Auth in a few lines of code.
• ⛑ 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 commaned to Railway or Fly.io via the CLI. Or deploy manually to any other hosting serivce of your choice.

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

• 🤝 Wasp Discord

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