Getting started

Requirements

• Node.js >= 22
• pnpm
• Docker (or a PostgreSQL database)

Create your project

pnpm create start-ui -t web myApp

That will scaffold a new folder with the latest version of 🚀 Start UI [web] 🎉

Installation

cp .env.example .env # Setup your env variables
cp .vscode/settings.example.json .vscode/settings.json  # (Optionnal) Setup your VS Code
pnpm install # Install dependencies
pnpm dk:init # Init docker
pnpm db:init # Init the db

Tip

Quick advices for local development
DON’T update the EMAIL_SERVER variable, because the default value will be used to catch the emails during the development.

Development

# Run the database in Docker (if not already started)
pnpm dk:start
# Run the development server
pnpm dev

Note

Don’t want to use docker?
Setup a PostgreSQL database (locally or online) and replace the DATABASE_URL environment variable. Then you can run pnpm db:push to update your database schema and then run pnpm db:seed to seed your database.