From 012379e92843b31dd626b9f49c2545def823f107 Mon Sep 17 00:00:00 2001
From: Firas Shmit <firas.shmit@capgemini.com>
Date: Tue, 24 Sep 2024 14:08:27 +0200
Subject: [PATCH] EW-998-doc added documentations for sync console

---
 README.md                                    |  5 +++++
 apps/server/src/infra/sync/console/README.md | 22 ++++++++++++++++++++
 2 files changed, 27 insertions(+)
 create mode 100644 apps/server/src/infra/sync/console/README.md

diff --git a/README.md b/README.md
index 606aa230d48..a30ca8805b2 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,11 @@ There is also some old documentation in the server code /apps/server/doc/*.md.
 
 Note that not all the .md file here are up to date.
 
+## NestJS Console Application
+
+### Sync console
+> Find the here [Documentation](./apps/server/src/infra/sync/console/README.md)
+
 
 ## Feathers application
 
diff --git a/apps/server/src/infra/sync/console/README.md b/apps/server/src/infra/sync/console/README.md
new file mode 100644
index 00000000000..cd3536b76f8
--- /dev/null
+++ b/apps/server/src/infra/sync/console/README.md
@@ -0,0 +1,22 @@
+# Sync console
+This is a console application that allows you to start the synchronization process for different sources.
+
+## Usage
+To start the synchronization process, run the following command:
+```bash
+npm run nest:start:console sync run <target>
+```
+
+Where `<target>` is the name of the system you want to start the synchronization for. The currently available systems are:
+- `tsp` - Synchronize Thüringer schulportal.
+
+If the target is not provided, the synchronization will not start and the available targets will be displayed in an error message.
+```bash
+{
+    message: 'Either synchronization is not activated or the target entered is invalid',  
+    data: { enteredTarget: 'tsp', availableTargets: { TSP: 'tsp' }}
+}
+```
+
+## TSP synchronization
+The TSP synchronization is controlled with a feature flag  `FEATURE_TSP_SYNC_ENABLED`. This is now set to `false`.
\ No newline at end of file