world-of-picross-api

Back-end of world-of-picross web application

Installation

Requirements

Python 3.12 (make sure it's the default python executable).

Installing the virtual environement

Open a Terminal at the project's root and execute

python -m venv .venv

Activating the virtual environment

Open the Terminal located at the project's root and execute

.venv\Scripts\activate

Installing the requirements

pip install -r requirements.txt

Creating the database

1. Install psql

2. Open the postgres REPL and execute the followings (replace ....... by an actual password) to create the database:

CREATE ROLE picross WITH LOGIN PASSWORD '.......';
CREATE DATABASE picross OWNER picross;

3. Open a Terminal at the root of the project and execute the followings to init the database:

psql -U picross -d picross -f app/database/init.sql

Creating the .env

Copy .env.example file, rename it .env and modify the informations depending on your setup. Make sure you set the DEBUG option to False when in production.

Running the server

Make sure you activated the python virtual environment and execute

Development

fastapi dev app/main.py

Production

fastapi run app/main.py