> ## Documentation Index
> Fetch the complete documentation index at: https://docs.s4kit.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Contributing

> Help build the future of SAP integration

Thanks for your interest in contributing to S4Kit!

## Quick Setup

<Steps>
  <Step title="Clone and Install">
    ```bash theme={null}
    git clone https://github.com/michal-majer/s4kit.git
    cd s4kit
    bun install
    ```
  </Step>

  <Step title="Start Database">
    ```bash theme={null}
    docker compose up -d postgres redis
    ```
  </Step>

  <Step title="Initialize Database">
    ```bash theme={null}
    cd packages/platform/backend
    bun x drizzle-kit push --force
    bun run db:seed
    bun run db:setup-admin
    ```
  </Step>

  <Step title="Start Development Servers">
    ```bash theme={null}
    # 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
    ```
  </Step>
</Steps>

**Login**: `admin@example.com` / `changeme123`

## Project Structure

| Package                       | Description                 |
| ----------------------------- | --------------------------- |
| `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 |

<Card title="Full Contributing Guide" icon="github" href="https://github.com/michal-majer/s4kit/blob/main/CONTRIBUTING.md">
  See the complete guide on GitHub →
</Card>
