README.md

Game Facts API

Helps users fetch facts about any games to integrate into their own games, quizzes or applications.

Tech Stack 💻

---

Setting up Virtual Environment

Venv is a tool that creates an isolated environment separate from other projects. Creating a virtual environment allows us to work on a Python project without affecting other projects that also use Python and their dependencies.

Install pip first

sudo apt-get install python3-pip

Then install venv

sudo apt install python3-venv

Now create a virtual environment

python3 -m venv {name_of_virtual_environment}

Activate your virtual environment:

source {name_of_virtual_environment}/bin/activate

Install all dependencies from requirements.txt

pip3 install -r requirements.txt

To deactivate:

deactivate

Run the project using uvicorn by executing the following command

uvicorn main:app --reload

Contributing

Contributions are always welcome!

See CONTRIBUTING.md for ways to get started.

Please adhere to this project's CODE OF CONDUCT.

Endpoints

Method	Path	Description
GET	/fact/game={games}?limit={limit}	Fetch facts about one or multiple games.
GET	/fact/random?limit={limit}	Fetch facts(s) about a random game.

Games must be seperated by "&"

---