Name	Name	Last commit message	Last commit date
parent directory ..
demo	demo
tekst	tekst
tests	tests
.env.dev	.env.dev
.env.template	.env.template
.env.test	.env.test
.gitignore	.gitignore
.justfile	.justfile
LICENSE	LICENSE
README.md	README.md
openapi.json	openapi.json
pyproject.toml	pyproject.toml
uv.lock	uv.lock

Name

Last commit message

Last commit date

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

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 recipes configured that can be run with just (a task runner). This is optional, but it helps a lot. Recipes can then be run via just <recipe name>. You'll get a commented overview of the configured recipes if you run just without any arguments (or look here).