dzigr/quiz

Fasapi project: simple quiz implementation

Linter status:

Quiz app

Stack:

• Python
• FastAPI
• PostgreSQL
• Docker

---

Start project with Docker

---

Note: Required Python & Poetry

1. Clone the repository

   git clone [email protected]:Dzigr/quiz && cd quiz
   

2. Initiate configuration with Makefile command

   make docker-install
   

   This will create .env file with necessary variables, requirements file and build docker containers

3. Run application by

   make docker
   

Without poetry

---

1. Create virtual environment

   python3 -m venv venv
   

2. Activate virtual environment

   source venv/bin/activate
   

3. Install requirements via pip

   pip install -r requirements.txt
   

4. Run docker-compose

   docker-compose up --build

---

Finally:

View endpoints

---

Usage:

GET /api/ping/ - checking application availability

POST /api/v1/questions/ - receive the body with number questions for further downloading, return the last uploaded question

Request example

{
    "questions_num": 5
}

Response example

{
  "question": "Sandburg called Chicago the \"City of Big\" these",
  "answer": "Shoulders",
  "created_at": "2022-12-30T19:21:03.128000Z"
}