This repository contains the source code for all components of the TIRA shared task platform.

Components:

• Backend (test coverage: )
• Frontend (test coverage: )
• Python Client (test coverage: )

• Wiki: Getting started with TIRA as a developer/administrator
• User Docs: Getting started with TIRA as a user
• Papers: List of publications
• Contribution Guide: How to contribute to the TIRA project

We use devcontainers for development. To start your environment, either use Github Codespaces (click on "Code" -> "Codespaces" in Github to open one) as easiest way to get started, or devpod as open source alternative (directly pointing to our Kubernetes or your local docker installation).

Run make to get an overview of all commands that will setup a self-contained tira application in your dev environment.

1. Setup the database and compile the vuetify frontend

   ~$ make setup

2. Start the local environment, point your browser to the specified URL

   ~$ make run-develop

3. Optionally: To work on real data, initialize your development database from a database dump via

   ~$ make import-data-from-dump

   or to work with mock data run:

   ~$ cd application
   ~$ make import-mock-data

If you use TIRA in your own research, please cite our paper

@InProceedings{froebe:2023b,
  address =                  {Berlin Heidelberg New York},
  author =                   {Maik Fr{\"o}be and Matti Wiegmann and Nikolay Kolyada and Bastian Grahm and Theresa Elstner and Frank Loebe and Matthias Hagen and Benno Stein and Martin Potthast},
  booktitle =                {Advances in Information Retrieval. 45th European Conference on {IR} Research ({ECIR} 2023)},
  month =                    apr,
  publisher =                {Springer},
  series =                   {Lecture Notes in Computer Science},
  site =                     {Dublin, Irland},
  title =                    {{Continuous Integration for Reproducible Shared Tasks with TIRA.io}},
  todo =                     {doi, month, pages, code},
  year =                     2023
}

MIT License