This repository is the Tikka ecosystem: frontend, SDK, backend, indexer, and oracle. Soroban smart contracts (Rust) live in a separate repo/folder and are not included here.
| Package | Role |
|---|---|
| client | Consumer web app — React 19, Vite, TypeScript. Reads from backend, writes via SDK. |
| sdk | NestJS library for Soroban contract interaction (tx build, simulate, sign, submit). Published as @tikka/sdk. |
| backend | API layer — auth (SIWS), metadata, indexer merge, notifications. NestJS, Fastify, Supabase. |
| indexer | Blockchain event ingestion — Horizon → decode → PostgreSQL (+ Redis cache). NestJS. |
| oracle | Randomness oracle — listens for draw requests, computes VRF/PRNG, submits to contract. NestJS. |
Docker and Docker Compose v2.
cp .env.example .env
cp backend/.env.example backend/.env.local # fill in SUPABASE_URL, JWT_SECRET, ADMIN_TOKEN
cp indexer/.env.example indexer/.env.local # fill in SOROBAN_RPC_URL, TIKKA_CONTRACT_ID
cp oracle/.env.example oracle/.env.local| Profile | What starts |
|---|---|
deps |
Postgres + Redis only |
backend |
deps + backend API (port 3001) |
indexer |
deps + indexer (port 3002) |
oracle |
deps + oracle (port 3003) |
full |
deps + backend + indexer + oracle |
client |
full + Vite client (port 5173) |
docker compose --profile full up --builddocker compose --profile backend up --build
docker compose --profile indexer up --builddocker compose --profile backend up -d
cd client && pnpm install && pnpm devdocker compose --profile full down -vAuto-generated TypeDoc reference for @tikka/sdk:
crackedstudio.github.io/tikka
Covers all public APIs organized by module: Raffle · Ticket · Wallet · User · Network · Utils.
To regenerate locally: cd sdk && npm run docs
- ARCHITECTURE.md — Full ecosystem specification with diagrams, data flows, contract interface, and API design
- RAFFLE_LIFECYCLE.md — Complete raffle lifecycle guide from creation through leaderboard update, with sequence diagrams and directory references
Release policy, versioning rules, and changelog procedures: docs/RELEASE.md
- SDK: Semantic Versioning (
MAJOR.MINOR.PATCH) - Apps: Calendar Versioning (
YYYY.MM.PATCH) - Database: Timestamped migrations with rollback procedures
See CHANGELOG.md for release history.
Module boundary and package ownership guidance: docs/contributing/MODULE_BOUNDARIES.md.
Soroban (Rust) raffle contracts are maintained outside this repo. Deploy and invoke them via the SDK once addresses are configured. Minor doc tweak for sync sync check