Skip to content

Latest commit

 

History

History
18 lines (14 loc) · 1.47 KB

README.md

File metadata and controls

18 lines (14 loc) · 1.47 KB
Raw

Tekst API

GitHub Workflow Status (tests) Ruff

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 Poetry as its dependency management and build tool. You can install Poetry from here.
  3. Install the project and its dependencies (from the project directory): poetry install
  4. You can now use
    • poetry run python -m tekst run --reload to run the dev server
    • poetry build to build the project
    • ...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).