Quick Start

Get Lygotype running locally in under 5 minutes.

Prerequisites

Node.js v20+
npm or yarn
A Stripe account (for payment features — optional for basic use)

1. Clone the repository

``bash git clone https://github.com/mangopaws/lygotype.git cd lygotype`

`2. Install dependencies`

`bash

`Install server dependencies`


cd server && npm install
Install client dependencies
cd ../client && npm install


3. Configure environment variables

`bash cp server/.env.example server/.env`

Open server/.env and fill in the required values. See Environment Variables for the full reference.

`4. Start the development servers`

`bash

`Terminal 1 — API server`


cd server
npm run dev
→ Running on http://localhost:3001

`bash

`Terminal 2 — React client`


cd client
npm run dev
→ Running on http://localhost:5173


5. Create your first form

1. Open http://localhost:5173` and create an account. 2. Click + New Form from the dashboard. Give it a name. 3. Click Add Question and choose from 17 question types. Drag to reorder. 4. Go to Settings → URL Slug. Set your slug, then click Publish. 5. Copy your form URL and share it. Responses appear in real time.

Want to skip local setup entirely? Use the Docker path in the Installation guide — one command and you're running.