Add note about samples in backend TypeScript docs

wuespace · Jan 6, 2024 · 68f8b74 · 68f8b74
1 parent 4b1d0ce
commit 68f8b74
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 0 deletions.
diff --git a/docs/docs/Backend Development/typescript/.pages b/docs/docs/Backend Development/typescript/.pages
@@ -4,4 +4,5 @@ nav:
   - configuration.md
   - message-bus.md
   - e2e-log-service.md
+  - samples.md
   - "API Reference ↗️": https://deno.land/x/telestion/mod.ts
diff --git a/docs/docs/Backend Development/typescript/index.md b/docs/docs/Backend Development/typescript/index.md
@@ -86,3 +86,7 @@ deno run --allow-all service.ts --dev
 Now that you have a basic service running, you should have a look at how to make your service configurable.
 
 [Read more about configuration](configuration.md){ .md-button }
+
+If you prefer to learn by example, you can also have a look at the [samples](samples.md).
+
+[Browse samples on GitHub](https://github.com/wuespace/telestion/tree/main/backend-deno/samples){ .md-button }
diff --git a/docs/docs/Backend Development/typescript/samples.md b/docs/docs/Backend Development/typescript/samples.md
@@ -0,0 +1,15 @@
+# Samples
+
+You can find even more samples in the project's GitHub repository under `backend-deno/samples`:
+
+[Browse samples on GitHub](https://github.com/wuespace/telestion/tree/main/backend-deno/samples){ .md-button }
+
+## Running the samples
+
+You can run all the samples using the `docker-compose.yml` file in the linked folder. Just run the following command:
+
+```bash
+docker-compose up
+```
+
+This will run all the samples, including the required NATS server.