Examples - Übersicht
Das Framework liefert lauffähige Beispiele unter
examples/
im Repo. Jedes ist eine voll funktionsfähige App, die du klonen
und starten kannst.
Was mitgeliefert wird
Abschnitt betitelt „Was mitgeliefert wird“| Beispiel | Demonstriert |
|---|---|
| Chat-Sample | Cluster + DistributedPubSub + sharded User-Sessions + HTTP/WS-Endpoint. |
| Voice-Sample | WebSocket + Kafka + PersistentActor + Projektionen. |
| Eigenständige Snippets | Häppchengroße Beispiele pro Konzept - Counter, Saga, Health, etc. |
Für den ersten Kontakt mit actor-ts starte mit dem Quickstart - das ist ein 5-Minuten Hello-Actor. Danach das Chat- oder Voice-Sample für eine funktionierende Multi-Feature-App.
Ein Beispiel ausführen
Abschnitt betitelt „Ein Beispiel ausführen“# Repo klonen:git clone https://github.com/pathosDev/actor-ts.gitcd actor-ts/examples/chat
# Installieren + starten:bun installbun run devJedes Beispiel hat seine eigene README mit Setup-Schritten.
Ein Beispiel auswählen
Abschnitt betitelt „Ein Beispiel auswählen“Wenn du sehen willst…
- Cluster + Entities → Chat-Sample.
- Broker-Integration (Kafka) → Voice-Sample.
- PersistentActor-Patterns → Voice-Sample.
- Distributed Pub/Sub → Chat-Sample.
- HTTP + WebSocket → beide Samples.
- Ein einzelnes Konzept isoliert → eigenständige Snippets.
Die Beispiele lesen
Abschnitt betitelt „Die Beispiele lesen“Die Beispiele folgen ein paar Konventionen:
src/actors/- Actor-Klassen.src/messages.ts- geteilte Nachrichten-Typen.src/main.ts- Einstiegspunkt mit Cluster-Join und HTTP-Server-Start.src/handlers/- HTTP-/WS-Route-Handler.
Ein Beispiel zu lesen dauert ~30 Minuten für die ganze Architektur; schneller, wenn du das Framework schon kennst.
Beispiele beitragen
Abschnitt betitelt „Beispiele beitragen“Wenn du etwas mit actor-ts baust und denkst, es würde anderen helfen - ein Saga-Workflow, eine Kafka-getriebene Analytics-Pipeline, ein Multi-Tenant-SaaS-Skeleton - PRs sind willkommen.
Beispiele, die aufgenommen werden:
- Self-contained - laufen ohne externe Services außer Docker / Compose.
- Dokumentiert - README mit was es tut + wie es funktioniert.
- Realistisch - lösen ein echtes Problem (nicht nur “zeig dieses Feature”).
Wohin als Nächstes
Abschnitt betitelt „Wohin als Nächstes“- Chat-Sample - Cluster + PubSub.
- Voice-Sample - Broker
- Persistenz.
- Eigenständige Snippets - Code pro Konzept.
- Quickstart - die 5-Minuten-Einführung.