DIS/PIS course example project

Description

A basic example project for a DIS/PIS course.

Installation

Create virtual environment:

python -m venv venv

Activate virtual environment:

# Windows
venv\Scripts\activate 

# Linux
source venv/bin/activate 

To install the required dependencies, run:

pip install -r requirements.txt

Usage

To run the project, run:

uvicorn app.main:app --host 127.0.0.1 --port 8000 --reload 

or start venv and run:

python main.py

After that you can go to http://localhost:8000/docs to see the API documentation.

Docker

To build the image, run:

docker build -t example-app-api .

Then run the image as container:

docker run -p 8000:8000 example-app-api