MicrosoftEggshell / elte_python_assignment1

Assignment 1 for Python

FastAPI Project

This is a FastAPI project designed for Assignment 1.

Installation

To run this project locally, you need to have Python and pip installed on your machine.

1. Clone this repository:

  git clone https://github.com/frdayvz85/assignment1.git
  or
  [e-mail]:frdayvz85/assignment1.git

2. Navigate into the project directory:

  cd assignment1

3. Create a virtual enviroment:

  python -m venv venv
  or
  py -m venv venv
  or
  py3 -m venv venv

4. Active a virtualenv

  Windows users from CMD run this command:
  .\venv\Scripts\activate.bat

  Windows users from PowerShell run this command:
  .\venv\Scripts\Activate.ps1

  Linux or Mac users run this command:
  source venv/bin/activate

5. Install the requirements in the current environment:

  pip install -r requirements.txt

6. Last step run the following command:

  py app/main.py

Testing APIs 🚀:

FastAPI documentation is automatically generated and interactive, meaning you can explore and test your API endpoints directly from a web browser. This documentation is generated based on the endpoint functions you define in your FastAPI application, along with their type hints, docstrings, and other metadata.

Accessing interface use following link:

  http://127.0.0.1:8000/docs

There is 1 testing Endpoint which it is for testing. You can check Root section and test it.

You can check Event APIs from Event section and test it:

  Good Luck 🚀