System requirements

Before you clone FastStaq, install a few tools and have a couple of accounts ready. This keeps your first run smooth.

Required tools

• Git for cloning the repository.
• Node.js 20 or newer (LTS recommended).
• pnpm 8 or newer, the package manager this monorepo uses (npm install -g pnpm).
• PostgreSQL for the database.
• Redis for caching, background job queues, and websockets.

The repository also ships a prerequisites checker. After cloning you can run pnpm check to confirm your environment is ready.

Running PostgreSQL and Redis

You have two easy options:

• Docker (recommended for local dev). The repository includes a Docker Compose setup that starts PostgreSQL and Redis for you.
• Native installs or managed services. Install them locally, or point FastStaq at hosted PostgreSQL and Redis. You will set the connection URLs in your environment file.

See Configure database and Redis for connection details.

Accounts you may need

Depending on which features you turn on:

• Stripe for payments. See Configure Stripe payments.
• An SMTP provider for transactional email. See Configure email and SMTP.
• An S3-compatible bucket (such as Cloudflare R2) for uploads. See Configure file storage (R2/S3).
• Google Cloud if you want Sign in with Google. See Configure Google OAuth.

You do not need all of these to boot the app locally. You can add them as you enable each feature.

Next step

Once your tools are installed, head to Clone and run locally.

Still need help?

Open a support ticket if you get stuck on prerequisites.