api/readme.md
2026-04-06 22:16:43 +02:00

13 lines
702 B
Markdown

# Reviews API
![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/api.g_it; cd api`
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. Run the server: `uvicorn app.main:app --host 127.0.0.1 --port 8001`