Skip to content
GitHub

Get started

Clone the monorepo and run a form locally.

Clone

git clone github.com/formexamples/form-examples.git
cd form-examples

Set up PostgreSQL

Create the role, then a database per form (example uses pre_operative_assessment_by_clinician):

createuser --host=localhost --port=5432 --superuser --pwprompt postgres || :
createdb --host=localhost --port=5432 --username=postgres --owner=postgres pre_operative_assessment_by_clinician_development || :
createdb --host=localhost --port=5432 --username=postgres --owner=postgres pre_operative_assessment_by_clinician_test || :
createdb --host=localhost --port=5432 --username=postgres --owner=postgres pre_operative_assessment_by_clinician_production || :

Or via psql:

CREATE USER postgres SUPERUSER PASSWORD 'postgres';
CREATE DATABASE pre_operative_assessment_by_clinician_development OWNER postgres;
CREATE DATABASE pre_operative_assessment_by_clinician_test OWNER postgres;

Scaffold a new form

bin/create-form my-new-form

This creates forms/my-new-form/ with the standard directory layout (index.md, AGENTS.md, spec/, sql/, front-end-with-html/, front-end-with-svelte/, back-end-with-axum/, etc.).

Verify

bin/test

Runs structural validation across all forms.

Full setup details are in the monorepo README.