{
  "markdown": "# ArDoCo REST\nDetails concerning the architectural decisions as well as the API responses can be found [here](architecture_decisions.md).\n\nRemark: There also exists another branch (`extra-result-controller`) which introduces a new controller to handle the retrieval of the TraceLinks separate\nfrom starting the pipeline. The branch also contains a ``.md`` file explaining the approach further.\n\n## how to run the API\n\n1. The API uses a Redis database. Add the credentials to ``redis/redis_template.env`` and rename the file to ``redis/redis.env``\n2. Start redis in docker from the docker-compose.yaml (``docker-compose up -d``)\n3. Start the application\n4. To access the API through the ui provided by swagger, go to http://localhost:8080/swagger-ui/index.html\n5. The contents of the database can be accessed through http://localhost:5540\n",
  "bytes": 838,
  "sha": "1d902d32c16551e0bfd37cb35c549c238fd93ca3841639778d0e95ca7f91c5ac",
  "repo_slug": "ardoco/rest",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/okf_ardoco_rest_openwiki_index_md_54ef77e6/readme"
}