README.md

Tekst API

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

Clone the parent repository via git clone https://github.com/VedaWebProject/Tekst.git
This project (in Tekst-API/) is configured to use uv as its project management tool. You can install uv** from here.
Install the project and its dependencies (from the Tekst-API/ project directory): uv sync
Run the development environment
- uv run fastapi dev tekst/app.py to run the dev server (...and so on)
- Local development also needs all the services running (MongoDB, Elasticsearch + some optional extras). The easiest way is to use the development compose stack in ../dev/compose.yml. This also contains a Caddy (web server) that manages routing of requests to the client dev server and the API. See this for reference.
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).