Skip to content

Create a Sapporta project

View as Markdown

Sapporta projects use pnpm. If Node.js is installed but pnpm is not available, enable pnpm through Corepack:

Terminal window
corepack enable pnpm

Create a project named task-app:

Terminal window
pnpm dlx sapporta init task-app

The Sapporta installation asks you to install the Sapporta skill. The skill is used both to build Sapporta projects and to operate them through coding agents. Ensure it is installed:

Terminal window
npx skills add https://github.com/jasim/sapporta-skills --skill sapporta

Start the local development server:

Terminal window
cd task-app
pnpm dev

The console prints the local browser URL. This is the Vite frontend server. It serves index.html and the React application, usually at:

http://localhost:5173

The backend API runs at:

http://localhost:3000

Open the local browser URL printed by pnpm dev. A new project opens at the signup screen when no signed-in session exists.

Generated Sapporta signup screen

Enter a name, email address, and password. The account requires email verification. In local development, the email server writes every message to the pnpm dev console. Open the verification URL from the console to verify the account.

Sapporta uses Better Auth for authentication. The authentication UI and related screens are present in the generated application and can be customized locally.

After verification, Sapporta creates the first workspace and assigns the first user as its owner. The app shell shows project navigation, generated table surfaces, the account workspace, and the starter welcome screen.

Generated Sapporta app after signup

The project name and table list in the app shell come from the project on disk. As tables are added to packages/api/schema/, the table navigation and generated record screens update with the running application.

Continue with Tour the generated project.