Installation
Every guide below is self-contained — it covers all prerequisites, infrastructure setup, and every command from zero to a running app. No jumping back and forth.
Choose your path
🔧 Monorepo — core development & demoing
Clone the full platform source to contribute to the core, work on framework features, or run a complete local demo.
| Platform | |
|---|---|
| 🍎 macOS | Open guide → |
| 🐧 Linux | Open guide → |
| 🪟 Windows | Open guide → |
📦 Standalone app — build without touching the core
Scaffold a standalone project that pulls Open Saasframe packages from npm. Your modules, overrides, and customisations live in your repo while the core stays untouched and upgradeable.
| Platform | |
|---|---|
| 🍎 macOS | Open guide → |
| 🐧 Linux | Open guide → |
| 🪟 Windows | Open guide → |
🐳 Docker dev setup — full stack in containers
Run the entire stack inside Docker with hot reload. No local Node.js or Yarn required. Works on any OS; on Windows it is slower than the native path.
🚀 VPS / production deployment
Deploy a production-ready Docker stack to any Linux server or VPS.
🛠️ Dev Container — zero-install VS Code environment
Open the repo in a fully pre-configured container. Docker Desktop + VS Code is all you need.
☁️ Railway - CLI-managed cloud deployment
Deploy a standalone app with saasframe deploy railway. The repeatable CLI flow provisions PostgreSQL, Redis, the app service, an optional worker, environment variables, and a public domain.