Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 3.98 KB

README.md

File metadata and controls

46 lines (28 loc) · 3.98 KB

Tekst

Tekst logo

...as in Text Exploration and Knowledge Structuring Tool

Server tests status Server tests coverage Client build status
GitHub commit activity GitHub code size GitHub repo size

🏗 Tekst is still in its initial development phase. As of now there's no complete (let alone production-ready) version available. As soon as we're ready for it, the new VedaWeb platform will become the first public instance of Tekst. Until then, you are welcome to follow the development of Tekst in this very repository.

Tekst is a collaborative, web-based research platform for aligning, displaying, linking, exploring, and enriching resources on natural language texts (and more). It is developed within the scope of the VedaWeb 2.0 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?

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 our conference paper here!

Contributing

Please see the contributing guidelines.

Development

This is a monorepo containing the codebases of the following parts of the Tekst platform:

Directory Description Technologies
Tekst-API API server project Python, Pydantic, FastAPI, FastAPI-Users, Beanie, MongoDB, Elasticsearch, ...
Tekst-Web Web client project TypeScript, Vue.js 3, Pinia, Naive UI, Vue I18n, OpenAPI-TypeScript & OpenAPI-Fetch, ...
Tekst-Util API maintenance utility script Bash, Bashly
docs Documentation and user manual, to be found here MkDocs, Material for MkDocs, PyMdown Extensions

Where applicable, the different project directories contain their own respective README.md files covering the development tooling and overall project setup.