Skip to main content
This guide walks you through getting Shipfastai running on your machine for the first time. By the end, you will have the full stack running locally — FastAPI backend on port 8000, Next.js frontend on port 3000, PostgreSQL via Supabase, and Redis — all orchestrated by Docker Compose.
1

Clone the repository

After purchase, you receive instant access to a private GitHub repository. Clone it to your local machine:
If you purchased the Basic tier, work from the products/basic/ directory. Pro and Enterprise tiers each have their own directory (products/pro/ and products/enterprise/).
2

Configure your environment

Copy the example environment file and fill in your credentials:
Open .env and set the following required variables before starting the app:The Supabase variables in .env.example connect to your Supabase project. Create a free project at supabase.com if you haven’t already.
3

Start with Docker

Start the full stack in the background with a single command:
Docker Compose starts the services: the FastAPI backend, the Next.js frontend, and Redis. On first run it will build the images, which takes a few minutes. Subsequent starts are fast.To watch the logs:
To stop all services:
4

Access the app

Once all containers are running, open the following URLs in your browser:The interactive API docs at /docs are generated automatically by FastAPI from your route definitions. Use them to test endpoints directly from the browser without any additional tooling.
To run the stack without Docker, start the backend and frontend in separate terminals:
You’ll need a running Supabase project for the database. The free tier at supabase.com is sufficient for local development.
The variables above cover the minimum required to start the app. For a full reference of every environment variable — including optional settings for Redis, email configuration, and deployment settings — see the Configuration section.