Skip to content

Latest commit

 

History

History
26 lines (16 loc) · 883 Bytes

README.md

File metadata and controls

26 lines (16 loc) · 883 Bytes
Raw

Tracktor API

| A playlist information API written with FastAPI

Why use an API?

Christoph Kepler and Felix Döring are cooperation in creating playlists. Both had the idea to include a description and the contents of those playlists on their websites.
To reduce redundant information an API is the easiest way to get them.

Usage

Run with Docker

  1. Clone this Repository
  2. Run docker-compose up --build

For development

  1. Clone this Repository
  2. Create an venv or simply run pip install -r requirements.txt
  3. Run uvicorn tracktor:main --reload

API Endpoints and Models

FasAPI generates an openapi.json.
To use a automatically build one have a look at the artifacts of the OpenAPI generation Workflow