diff --git a/README.md b/README.md index 606aa230d48..30d15f57ee8 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 Applications + +### Sync console +> Find the [Documentation](./apps/server/src/infra/sync/console/README.md) here. + ## 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 +``` + +Where `` 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