/valhapi

API for valhalla project

Primary LanguagePython

VALHALLA API

Description

Valhapi is an API developed with FastAPI. This project includes instructions for setting up and running the API on a Windows environment.

Note

This project currently only works on Windows OS for the database URL, but Im working on changing this.

Requirements

Installation

Install the project

git clone https://github.com/EliasLeguizamon123/valhapi.git
cd valhapi
python -m venv venv
.\venv\Scripts\Activate.ps1

pip install -r requirements.txt || pip install fastapi uvicorn pyinstaller

Run project

uvicorn app.main:app --reload  || python -m uvicorn app.main:app --reload

Docs

Just go to the following URL to see the API documentation:

http://127.0.0.1:8000/docs

Build

for build this project you need to check first if you venv is activated, then you can run the following command:

pyinstaller --clean valhapi.spec