Zum Hauptinhalt springen

Skin to Go

Skin to Go ist eine CS2-Skin-Trading-Plattform mit React/Vite-Frontend, Express/PostgreSQL-Backend und Steam-Bot-Escrow für Listings und Trades.

Diese Dokumentation ist die zentrale Wissensquelle für:

  • lokales Setup und Docker-Workflows
  • Architekturentscheidungen
  • Deployment und Betrieb
  • Produktlogik rund um Listings, Trades, Wallets und Top Trader
  • Sicherheitsregeln für Secrets, Serverzugriffe und Webhooks

Die bevorzugte öffentliche Domain ist docs.skintogo.de. documentation.skintogo.de wird bewusst nicht verwendet, weil docs der übliche kurze Standard für technische Dokumentation ist.

Projekt-Repositories​

  • Hauptprojekt: skin_to_go
  • Dokumentation: skin_to_go_docs

Das Docusaurus-Repo soll zusätzlich zum Hauptprojekt im VSCode-Workspace geöffnet werden. So bleibt die Dokumentation während der Entwicklung als Kontext verfügbar und kann direkt gepflegt werden.

Wichtige Prinzipien​

  • Das Hauptprojekt läuft über Docker.
  • Lokale Node-, npm-, Prisma-, Test- und Datenbankbefehle für das Hauptprojekt laufen über bestehende Service-Container.
  • Keine echten Secrets dokumentieren, loggen oder committen.
  • Beispielwerte klar als Beispiele kennzeichnen.
  • Architektur-Dokumentation, Produktlogik und operative Runbooks bleiben getrennt.
  • Markdown ist das primäre Pflegeformat.
  • Die Doku ist für spätere Versionierung, API-Dokumentation, interne Runbooks und Mehrsprachigkeit vorbereitet.

Schnelleinstieg​

Für die tägliche lokale Entwicklung im Hauptprojekt:

cp .env.example .env
mkdir -p secrets
./scripts/local/docker-up.sh

Danach sind erreichbar:

  • Frontend: http://localhost:8080
  • Backend direkt: http://localhost:3001
  • PostgreSQL direkt: localhost:5432

Details stehen in Lokales Setup, Docker, Secrets und Environment-Konfiguration.