Squiglink API

The API powering the next generation of Squiglink Lab and Studio while preserving backwards compatibility with CrinGraph and forks.

Install

# Copy the configuration file.
cp .env.example .env

# Fill in the configuration file.
edit .env

# Install dependencies.
docker compose run api pnpm install

# Migrate the database.
docker compose run api pnpm kysely migrate:latest

# Seed the database (development-only).
docker compose run api pnpm kysely seed run

# Migrate the test database (development-only).
docker compose run api pnpm kysely-test migrate:latest

# Start the containers.
docker compose up

Done? Send requests to http://localhost:3000 or host instances of Lab and Studio.

Tips

# Generate type definitions from the database.
docker compose run api pnpm kysely-codegen

# Lint the code.
docker compose run api pnpm oxlint --deny-warnings

# Check for formatting errors in the code.
docker compose run api pnpm prettier --check .

# Fix formatting errors in the code.
docker compose run api pnpm prettier --write .

# Run tests.
docker compose run api pnpm test