diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..d6b8819 --- /dev/null +++ b/readme.md @@ -0,0 +1,15 @@ + + +# Site + +![FastAPI](https://img.shields.io/badge/FastAPI-009688?style=flat&logo=FastAPI&logoColor=white) ![Scalar](https://img.shields.io/badge/Scalar-1A1A1A?style=flat&logo=Scalar&logoColor=white) + +This repo contains the files for creating my Reviews API demo at[gugulet.hu/technical/api](https://gugulet.hu/technical/api). + +## Setup steps + +1. Clone the repo and enter the directory: `git clone git:git.gugulet.hu/g_it/site.g_it; cd site` +2. Setup the virtual environment: `python3 -m venv .venv` +3. Activate the virtual environment: `source .venv/bin/activate` +4. Install all the packages: `pip install -r requirements.txt` +5. Activate direnv: `direnv allow` diff --git a/skills.md b/skills.md new file mode 100644 index 0000000..05fdfa2 --- /dev/null +++ b/skills.md @@ -0,0 +1,20 @@ +# API + +Read-only REST API exposing 20+ years of personal media reviews (movies, books, television) from a SQLite database. + +## Stack + +- Python 3.14 / FastAPI 0.115 +- Uvicorn +- SQLite +- Scalar (API documentation UI) +- Docker + +## Skills + +- FastAPI REST API design with Pydantic models +- SQLite querying with pagination and filtering +- API documentation with Scalar UI +- Docker containerisation +- Statistics and aggregation endpoints +- Rating scale design (-3.0 to 3.0)