Schemaful

Quickstart

Get Schemaful running locally in under 5 minutes.

Prerequisites

Before you begin, make sure you have:

  • • Node.js 22+ installed
  • • pnpm package manager (or npm/yarn)
  • • A PostgreSQL database (local or hosted)

Don't have a database? We recommend Neon (free tier available) or Supabase.

1. Create a New Project

Run the create command to scaffold a new Schemaful project:

npx create-schemaful@latest my-cms

This creates a new directory with the Schemaful app and all dependencies.

2. Configure Database

Create a .env file in your project root:

.env
DATABASE_URL=postgresql://user:password@host:5432/database

Replace with your actual PostgreSQL connection string.

3. Initialize Database

Run the database migration to create the required tables:

cd my-cms
pnpm db:push

This creates the CMS tables: locales, schemas, fields, entries, and assets.

4. Start Development Server

Launch the development server:

pnpm dev

Open http://localhost:3000 to access the Schemaful dashboard.

5. Create Your First Schema

In the dashboard, go to Schemas → Create Schema and define a content type:

  1. Enter a schema ID (e.g., blog-post)
  2. Add a display name (e.g., "Blog Post")
  3. Add fields: title (Symbol), content (RichText), slug (Symbol)
  4. Save the schema

6. Create Content

Go to Entries → Create Entry, select your schema, and add content. Your content is now stored in PostgreSQL and accessible via the API.

Next Steps