Update readme

This commit is contained in:
2026-09-03 16:11:13 +02:00
parent 4996fa7baa
commit cc226d6ce6
+5 -5
View File
@@ -2,8 +2,8 @@
This repository contains the source code of the concordancer which is a part of the [Terminology Portal](https://github.com/clarinsi/rsdo_term_portal). This repository contains the source code of the concordancer which is a part of the [Terminology Portal](https://github.com/clarinsi/rsdo_term_portal).
There are two main parts: There are two main parts:
- Web application with backend (API interface) written in ASP.NET Core 6 and frontend written in React - Web application with backend (API interface) written in ASP.NET Core 10 and frontend written in React
- System Manager which is written in .NET 6 and is used to initially set up the system - System Manager which is written in .NET 10 and is used to initially set up the system
## Prerequisites ## Prerequisites
Web application requires following external dependencies Web application requires following external dependencies
@@ -16,7 +16,7 @@ To build a frontend application successfully, first, [Node.js](https://nodejs.or
Use `npm install` to install all required dependencies, and `npm run build` to build the application. Use `npm install` to install all required dependencies, and `npm run build` to build the application.
For more info see the [Readme](src/apps/Rsdo.Concordancer.Api/WebApp/README.md) inside the frontend [root](src/apps/Rsdo.Concordancer.Api/WebApp) folder. For more info see the [Readme](src/apps/Rsdo.Concordancer.Api/WebApp/README.md) inside the frontend [root](src/apps/Rsdo.Concordancer.Api/WebApp) folder.
### Backend (ASP.NET Core 6) and System Manager (.NET 6) ### Backend (ASP.NET Core 10) and System Manager (.NET 10)
Open [Rsdo.Concordancer.sln](src/Rsdo.Concordancer.sln) inside of your IDE and build the solution, or use `dotnet build` command to build the solution. All required dependencies will be installed via NuGet packages. Open [Rsdo.Concordancer.sln](src/Rsdo.Concordancer.sln) inside of your IDE and build the solution, or use `dotnet build` command to build the solution. All required dependencies will be installed via NuGet packages.
## Creating docker images ## Creating docker images
@@ -38,13 +38,13 @@ Use following [Dockerfile](src/apps/Rsdo.Concordancer.SystemManager/Dockerfile)
### Web application ### Web application
Web application must be configured with the following Environment variables and values: Web application must be configured with the following Environment variables and values:
- `RSDO:Database:MasterConnectionString` holds connection string to the main database; e.g.: `rsdo_db;Username=rsdo;Password=strongpassword;Database=Concordancer` - `RSDO:Database:MasterConnectionString` holds connection string to the main database; e.g.: `Host=rsdo_db;Username=rsdo;Password=strongpassword;Database=Concordancer`
- `RSDO:Elastic:ConnectionString` holds connection string to OpenSearch server; e.g.: `http://rsdo_opensearch:9200` - `RSDO:Elastic:ConnectionString` holds connection string to OpenSearch server; e.g.: `http://rsdo_opensearch:9200`
- `RSDO:Tokenizer:ClasslaUrl` holds and url to external service which is used for tokenizing search strings; e.g.: `https://orodja.cjvt.si/oznacevalnik/ajax_api/v1/slv/process` - `RSDO:Tokenizer:ClasslaUrl` holds and url to external service which is used for tokenizing search strings; e.g.: `https://orodja.cjvt.si/oznacevalnik/ajax_api/v1/slv/process`
### System Manager ### System Manager
System manager must be configured with the following Environment variables and values: System manager must be configured with the following Environment variables and values:
- `RSDO:Database:MasterConnectionString` holds connection string to the main database; e.g.: `rsdo_db;Username=rsdo;Password=strongpassword;Database=Concordancer` - `RSDO:Database:MasterConnectionString` holds connection string to the main database; e.g.: `Host=rsdo_db;Username=rsdo;Password=strongpassword;Database=Concordancer`
- `RSDO:Elastic:ConnectionString` holds connection string to OpenSearch server; e.g.: `http://rsdo_opensearch:9200` - `RSDO:Elastic:ConnectionString` holds connection string to OpenSearch server; e.g.: `http://rsdo_opensearch:9200`
## Using System Manager ## Using System Manager