Skip to content
Snippets Groups Projects

Develop

Merged Michelle Weidling requested to merge develop into main
1 file
+ 2
2
Compare changes
  • Side-by-side
  • Inline
+ 7
5
@@ -80,7 +80,7 @@ To pass credentials to the container, we use the file `ahikar.env` which is not
- TGUSER
- TGPASS
For local development this file MUST be present but can be left empty. In this case, the SADE Publish Tool may be used to import data from TextGrid.
For local development this file MUST be present but can be left empty. In this case, TextGrid Connect Standalone may be used to import data from TextGrid.
```bash
touch docker/ahikar.env
@@ -114,14 +114,16 @@ docker-compose --env-file docker/.env --file docker/docker-compose.yml up --deta
## Connecting the Backend with the Frontend
The corresponding frontend for the Ahiwar backend is the [EMo viewer](https://gitlab.gwdg.de/subugoe/emo/Qviewer).
In order to connect it with the simply has to expose a REST API that complies to the specification of the [SUB's generic TextAPI](https://subugoe.pages.gwdg.de/emo/text-api/)
The frontend takes care of the data transfer as described in the [frontend's README](https://gitlab.gwdg.de/subugoe/emo/Qviewer/-/blob/develop/README.md#connecting-the-viewer-with-a-backend).
The corresponding frontend for the Ahiqar backend is [Ahiqar's version of the TIDO viewer](https://gitlab.gwdg.de/subugoe/ahiqar/ahiqar-tido).
In order to connect the back end with the viewer, the former simply has to expose a REST API that complies to the specification of the [SUB's generic TextAPI](https://subugoe.pages.gwdg.de/emo/text-api/).
The specification of the project specific API can be found at the [API's documentation page](https://subugoe.pages.gwdg.de/ahiqar/api-documentation/).
The frontend takes care of the data transfer as described in [TIDO's README](https://gitlab.gwdg.de/subugoe/emo/Qviewer/-/blob/develop/README.md#connecting-the-viewer-with-a-backend).
## API documentation
The backend comes shipped with an OpenAPI documentation of its API.
The docs are available at <https://ahikar-dev.sub.uni-goettingen.de/openapi>.
The docs are available at <https://ahikar-dev.sub.uni-goettingen.de/openapi> or at <https://subugoe.pages.gwdg.de/ahiqar/api-documentation/>.
### Interplay of TextAPI and AnnotationAPI
Loading