Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/bcanata/maieutic/llms.txt

Use this file to discover all available pages before exploring further.

Maieutic runs entirely on your machine. There is no hosted instance — you clone the repo, set two environment variables, apply the database migrations, and start the dev server. The steps below walk through every command in order.

​
Prerequisites

  • Node.js 20 or later — check with node --version
  • An Anthropic API key — get one at console.anthropic.com

​
Setup

1

Install dependencies

Clone the repository and install packages:
npm install
2

Configure environment variables

Copy the example env file and fill in your key:
cp .env.example .env.local
Open .env.local and set both variables:
ANTHROPIC_API_KEY=sk-ant-...
DATABASE_URL="file:./dev.db"
See Environment configuration for details on each variable.
3

Apply database migrations

Initialize the SQLite database and generate the Prisma client:
npx prisma migrate dev
4

Seed demo data (optional)

Load three demo students — Ana, Beto, and Carmen — along with pre-built cohort sessions so you can explore the instructor dashboard without running exercises yourself:
npm run reset-demo
This wipes the database and replays captured fixtures with rebased timestamps so the live dashboard looks active. Ana and Beto have completed sessions; Carmen’s session is still in progress.
Skip this step if you want to start with a blank database and create your own exercises and sessions from scratch.
5

Start the dev server

npm run dev
6

Open the app

Navigate to http://localhost:3000.The landing page asks whether you are a student or a teacher — no login required. Select your role to proceed:
  • Students are routed to /exercises — an exercise list grouped by unit.
  • Instructors are routed to /live — the live class dashboard showing active student sessions.

​
Quick reference

All commands in one place: 
npm install
cp .env.example .env.local
# Edit .env.local: set ANTHROPIC_API_KEY and DATABASE_URL
npx prisma migrate dev
npm run reset-demo   # optional
npm run dev

​
Where to go next

Once the server is running, your starting point depends on your role:
  • Students — head to /exercises to see available exercises grouped by unit, pick one, and begin phase 1 (specification).
  • Instructors — head to /live for the real-time dashboard, or to the exercise library to author new problems.

Build docs developers (and LLMs) love

Get started for freeTalk to us