Tekst-API

Tekst API

This project holds the codebase for the server part of the Tekst platform. For general information on Tekst, visit the Tekst repository.

Development

1. Clone this repository via git clone https://github.com/VedaWebProject/Tekst-API.git
2. This project is configured to use uv as its project management tool. You can install uv** from here.
3. Install the project and its dependencies (from the project directory): uv sync
4. You can now use
   • uv run fastapi dev tekst/app.py to run the dev server
   • ...and so on
5. The project has some very convenient tasks configured that can be run with Task (a task runner). This is optional, but it helps a lot. You can install it form here. Tasks can then be run via task <taskname>. You'll get a commented overview of the configured tasks if you run task without any arguments (or look here).