Skip to main content
Thanks for your interest in contributing to S4Kit!

​
Quick Setup

1

Clone and Install

git clone https://github.com/michal-majer/s4kit.git
cd s4kit
bun install
2

Start Database

docker compose up -d postgres redis
3

Initialize Database

cd packages/platform/backend
bun x drizzle-kit push --force
bun run db:seed
bun run db:setup-admin
4

Start Development Servers

# Terminal 1 - Backend
cd packages/platform/backend && bun run dev

# Terminal 2 - Frontend
cd packages/platform/frontend && bun run dev

# Terminal 3 - Proxy
cd packages/platform/proxy && bun run dev
Login: admin@example.com / changeme123

​
Project Structure

PackageDescription
packages/sdk/NPM client library + CLI
packages/platform/backend/Admin API (Hono.js)
packages/platform/frontend/Dashboard (Next.js)
packages/platform/proxy/SDK proxy service
packages/shared/Shared schema and utilities

Full Contributing Guide

See the complete guide on GitHub →