Setup

This guide will walk you through setting up supastarter. We will go through the process of cloning the project, installing dependencies, setting up your database and running the local development server.

Prerequisites

Before you can get started, you will need to have the following installed on your machine.

Node.js (v20 or higher)
Git
pnpm
VS Code (recommended, or any other code editor)

Project setup

Create a new database

supastarter uses Prisma as an ORM (database access layer). This means you can use any database supported by Prisma, including PostgreSQL, MySQL, SQLite, and MongoDB. You can find all supported databases here.

Before creating a new supastarter project, make sure to have created a new database and have the connection string ready. For example when using PostgreSQL, the connection string will look something like this:

postgresql://user:password@host:port/database

Recommended database providers are Supabase, PlanetScale and Neon.

You can also find setup guides for certain providers in the supastarter blog:

Supabase

Initialize a new supastarter project

During the setup process you will be asked to provide the following information:

Project name - The name of your project
Database provider - The database provider you are using
Database connection string - The connection string of your database

To create a new supastarter project all you need to do is run the following command (replace my-awesome-project with the name of your project):

npx supastarter new my-awesome-project

This will clone and configure the supastarter repository, install all the dependencies and set up the database for you.

If you encounter any errors during the setup process, please try the manual setup instead.

Set up your storage provider

Storage is necessary to upload and serve files like images for example for the avatars of users and teams. supastarter supports all S3-compatible storage providers like AWS S3, DigitalOcean Spaces, MinIO, etc. and Supabase Storage.

Storage setup guide

Start your development server

Now your app should be ready to go. To start the local development server, navigate into your project root folder and run the following command.

pnpm dev

Open http://localhost:5173 in your browser to see the your app.