Skip to content

Repository files navigation

Scaffold

Scaffold helps you define a software project's architecture and export it as a structured PROJECT.md for AI coding agents to follow.

Create a project, choose its frontend, backend, database, UI system, and integrations, then review, save, and download the generated specification.

Stack

  • TanStack Start, TanStack Router, React, and TypeScript
  • Tailwind CSS and Radix UI primitives
  • SQLite with Drizzle ORM
  • Bun

Requirements

  • Bun installed

Run locally

  1. Install dependencies:

    bun install
  2. Create your local environment file:

    cp .env.example .env
  3. Create and seed the SQLite database:

    bun run db:migrate
    bun run db:seed
  4. Start the development server:

    bun run dev

Open http://localhost:3000. The root route redirects to the project dashboard.

Useful commands

bun run typecheck  # Check TypeScript
bun run lint       # Run ESLint
bun run test       # Run tests
bun run build      # Create a production build
bun run start      # Run the production build

Database

The default database location is data/scaffold.sqlite, configured through DATABASE_URL in .env. Database migrations are stored in drizzle/.

To generate a new migration after updating the schema:

bun run db:generate
bun run db:migrate

Project structure

src/
├── components/           # Shared UI and project-builder components
├── db/                   # SQLite client, schema, migrations, and seeding
├── features/             # Project, stack-catalog, and specification logic
└── routes/               # TanStack Start file-based routes

For product requirements and architecture decisions, see PROJECT.md.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages