Skip to content

RakuJa/BYBE

Repository files navigation

Python FastAPI Redis Ruff License: MIT

SonarCloud

BYBE

Pathfinder 2e - Encounter Builder BACKEND

Installation guide using Docker

  1. Install Docker on your local machine
  2. Download redis on your local machine:
docker pull redis
  1. Clone the repository or download the ZIP
git clone https://github.com/RakuJa/BYBE
  1. Go to the local BYBE project folder

  2. Build docker image of bybe using

docker build -t bybe .
  1. Run the image
docker run -p 25566:25566 --name bybe-container bybe

Instead of creating a bybe docker instance you may want to run it directly.

gunicorn app.controller:app --config app/gunicorn.conf.py

Gunicorn will have first class support, but you may use uvicorn like:

uvicorn app.controller:app --host 127.0.0.1 --port 25566