An open API service indexing awesome lists of open source software.

https://github.com/vedawebproject/tekst

A collaborative research platform for resources on natural language texts
https://github.com/vedawebproject/tekst

collaboration linguistics philology platform research-data research-tool self-hosted text

Last synced: 2 months ago
JSON representation

A collaborative research platform for resources on natural language texts

Awesome Lists containing this project

README

          

# Tekst

Tekst logo

A collaborative, web-based research platform for aligning, linking, publishing, exploring and enriching resources on natural language texts.

![Tekst-API tests status](https://img.shields.io/github/actions/workflow/status/VedaWebProject/Tekst/api-tests.yml?label=API%20tests)
[![Tekst-API tests coverage](https://img.shields.io/coverallsCoverage/github/VedaWebProject/Tekst?branch=main&label=API%20tests%20coverage)](https://coveralls.io/github/VedaWebProject/Tekst?branch=main)
![Tekst-Web code checks status](https://img.shields.io/github/actions/workflow/status/VedaWebProject/Tekst/web-checks.yml?label=client%20checks)

> [!IMPORTANT]
> Tekst is still in development. We're currently testing Tekst internally and implementing the last missing bits. As soon as we're ready for it, the new [VedaWeb platform](https://vedaweb.uni-koeln.de) will become the first public instance of Tekst. Until then, you are welcome to follow the development in this very repository.

Tekst is developed within the scope of the [VedaWeb 2.0](https://vedaweb.uni-koeln.de/) research project on Old Indic texts, where it constitutes the technical basis of the research platform "VedaWeb", which will be launched in its new form as part of the project's efforts.

## Manual

You are looking for information on concepts, use cases, features, setup, deployment or administration of the Tekst platform?

### Click here for the [📖 _Tekst_ manual](https://vedawebproject.github.io/Tekst)!

## Publications

We presented our vision for a collaborative text research platform at the **DH2023** conference (Digital Humanities 2023. Collaboration as Opportunity, Graz, Austria, 10-14 July 2023). You can find the abstract of our presentation [here](https://doi.org/10.5281/zenodo.8107794)!

## Contributing

Please see the [contributing guidelines](CONTRIBUTING.md).

## Development

This is a monorepo containing the codebases of all parts of the Tekst platform. Where applicable, the different project directories contain their own respective `README.md` files covering the development tooling and overall project setup.

### Projects and technologies overview

#### Tekst-API
The server part of the Tekst platform: [`Tekst-API/`](Tekst-API) \
[Python](https://github.com/python/cpython), [Pydantic](https://github.com/pydantic/pydantic), [FastAPI](https://github.com/tiangolo/fastapi), [FastAPI-Users](https://github.com/fastapi-users/fastapi-users), [Beanie](https://github.com/BeanieODM/beanie), [MongoDB](https://github.com/mongodb/mongo), [Elasticsearch](https://github.com/elastic/elasticsearch), ...

#### Tekst-Web
The client part of the Tekst platform: [`Tekst-Web/`](Tekst-Web) \
[TypeScript](https://github.com/microsoft/TypeScript), [Vue.js 3](https://github.com/vuejs/core), [Pinia](https://github.com/vuejs/pinia), [Naive UI](https://github.com/tusen-ai/naive-ui), [Vue I18n](https://github.com/intlify/vue-i18n), [OpenAPI-TypeScript & OpenAPI-Fetch](https://github.com/openapi-ts/openapi-typescript), ...

#### Tekst Documentation
The official docs for the Tekst platform (published [here](https://vedawebproject.github.io/Tekst)): [`docs/`](docs) \
[MkDocs](https://github.com/mkdocs/mkdocs), [Material for MkDocs](https://github.com/squidfunk/mkdocs-material), [PyMdown Extensions](https://github.com/facelessuser/pymdown-extensions), ...