Prerequisites
Make sure you have these tools installed before getting started
🚀 Want to get started fast?
Check out the Quick Start guide for a streamlined setup process that gets you running in under 15 minutes.
Before you can run this SaaS starter kit locally, you'll need these essential tools. This is a reference guide - for step-by-step setup, see the Quick Start guide.
Required Tools Checklist
Node.js 18 or Higher
Node.js is a JavaScript runtime that allows you to run the application on your computer.
Version Requirement
Installation:
- Download from nodejs.org
- Choose the "LTS" (Long Term Support) version
- Follow the installer instructions for your operating system
Git
Git is a version control system that helps you manage code changes and collaborate with others.
Installation:
- Download from git-scm.com
- Follow the installer instructions for your operating system
- Use default settings unless you know what you're doing
Code Editor (VS Code Recommended)
You'll need a code editor to view and modify the source code. We recommend Visual Studio Code because it has excellent support for TypeScript and React.
Recommended: Visual Studio Code
- Download from code.visualstudio.com
- Free and open source
- Works on Windows, macOS, and Linux
Helpful VS Code Extensions (Optional but Recommended):
- ESLint - Catches code errors as you type
- Prettier - Automatically formats your code
- Tailwind CSS IntelliSense - Autocomplete for Tailwind classes
- Prisma - Syntax highlighting for database schema files
Package Manager: npm (Included with Node.js)
npm (Node Package Manager) is used to install project dependencies. It comes bundled with Node.js, so if you installed Node.js in Step 1, you already have npm!
Alternative Package Managers
Terminal/Command Line Access(Optional)
You'll need to run commands in a terminal to install dependencies and start the development server.
Recommended Terminals by Platform:
- Windows: Git Bash (installed with Git) or Windows Terminal
- macOS: Terminal (built-in) or iTerm2
- Linux: Your default terminal emulator
View → Terminal or with the keyboard shortcut Ctrl+` (Windows/Linux) or Cmd+` (macOS).Optional Tools
GitHub Account (for OAuth Login)
If you want to enable GitHub authentication, you'll need a GitHub account to create OAuth credentials.
Google Account (for Google OAuth Login)
If you want to enable Google authentication, you'll need a Google account to create OAuth credentials.
Related Guides
Next Steps
Once you have these tools installed, choose your path:
- 🚀 Quick Start Guide → Get up and running in under 15 minutes (recommended)
- Installation Guide → Detailed step-by-step installation process