Next.js
Getting started

supastarter for Next.js 14

This guide will walk you through setting up supastarter for Next.js (with app router). We will go through the process of cloning the project, installing dependencies, setting up your database and running the local development server.

Tools & libraries

Before we start I quickly want to go over the tools and libraries that supastarter uses.

Prerequisites

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

Project setup

Create a new database

supastarter uses Prisma (opens in a new tab) 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 (opens in a new tab).

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 (opens in a new tab), PlanetScale (opens in a new tab) and Neon (opens in a new tab).

You can also find setup guides for certain providers in the supastarter blog (opens in a new tab):

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 the supastarter repository, install all the dependencies and set up the database for you.

If you get 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 multiple storage providers, so please ollow the instructions for your preferred provider:

S3 or S3 compatible (like Cloudflare R2)Supabase Storage

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:3000 (opens in a new tab) in your browser to see the your app.

Project structure & architecture