Development Setup

Prerequisites

• Node.js >= 20
• npm >= 10
• Docker and Docker Compose (for local database instances)

Setup

1. Clone the repository

git clone https://github.com/zequel-labs/zequel.git
cd zequel

2. Install dependencies

npm install

3. Start the development databases

docker compose up -d

This starts seven database containers with seed data:

Service	Host Port	Credentials
PostgreSQL	54320	zequel / zequel
MySQL	33061	zequel / zequel
MariaDB	33070	zequel / zequel
SQL Server	14330	sa / Zequel123!
MongoDB	27018	zequel / zequel
Redis	63790	password: zequel
ClickHouse	18123 (HTTP), 19000 (Native)	zequel / zequel

SQLite and DuckDB are file-based databases and don't need Docker containers. The SQLite database file is at docker/sqlite/zequel.db. Recreate it with:

sqlite3 docker/sqlite/zequel.db < docker/sqlite/init.sql

See Connection URLs for ready-to-paste connection strings.

If you only need specific databases, start them individually:

docker compose up -d postgres redis

4. Run the app

npm run dev

5. Run tests

# Unit tests
npm run test:unit

# Integration tests (requires Docker databases running)
npm run test:integration

# All tests in watch mode
npm test

# Coverage report
npm run test:coverage

6. Build for production

npm run build

The output will be in the dist/ directory. See Releasing for full release instructions.