Documentation Index
Fetch the complete documentation index at: https://mintlify.com/whitiue/logiMathApp/llms.txt
Use this file to discover all available pages before exploring further.
Before you can run LogiMath, you need a few tools installed on your machine. The recommended path uses Docker and Docker Compose to manage the backend and database as containers, so you don’t need a local PostgreSQL installation. If you prefer to run services directly, you need Python 3.9 or later and a PostgreSQL database available locally.
Required software
Running LogiMath with Docker Compose requires the following tools:| Tool | Minimum version | Purpose |
|---|
| Docker | 24.x | Builds and runs containers |
| Docker Compose | 2.x | Orchestrates backend and database services |
| Git | Any recent | Clones the repository |
Install Docker
Download and install Docker Desktop for Windows or macOS. On Linux, install the docker.io and docker-compose-plugin packages for your distribution.Verify your installation
After installing, confirm both tools are available:docker --version
# Docker version 24.x.x
docker-compose --version
# Docker Compose version 2.x.x
On Linux, you may need to add your user to the docker group to run Docker commands without sudo: sudo usermod -aG docker $USER. Log out and back in for the change to take effect.
Running LogiMath without Docker requires the following tools installed on your machine:| Tool | Minimum version | Purpose |
|---|
| Python | 3.9+ | Runs the backend and frontend |
| Git | Any recent | Clones the repository |
| PostgreSQL | 15+ | Database for the backend |
Install Python
Download Python 3.9 or later from python.org. Verify your installation:python --version
# Python 3.9.x or later
pip --version
Backend dependencies
The backend (src/BackEnd/requirements.txt) requires:fastapi==0.136.1
uvicorn[standard]==0.32.0
sqlalchemy==2.0.49
psycopg2-binary==2.9.12
pydantic==2.13.3
python-dotenv==1.2.2
Frontend dependencies
The frontend (src/FrontEnd/requirements.txt) requires:flet==0.85.1
requests==2.31.0
python-dotenv==1.0.0
Install these with pip install -r requirements.txt inside each service directory, ideally inside a virtual environment. See the quickstart page for the full setup steps. Environment file setup
LogiMath reads configuration from a .env file in the project root. The repository includes .env.example with all required variables:
# PostgreSQL
POSTGRES_USER=logmath_user
POSTGRES_PASSWORD=logmath_pass_change_me_in_production
POSTGRES_DB=logmath_db
# Backend
DATABASE_URL=postgresql://logmath_user:logmath_pass_change_me_in_production@postgres:5432/logmath_db
API_HOST=0.0.0.0
API_PORT=8000
POSTGRES_PASSWORD with a value you choose. The DATABASE_URL uses postgres as the hostname because that is the service name defined in docker-compose.yml — do not change this hostname when running with Docker.
Never commit your .env file to version control. It is listed in .gitignore by default. Keep credentials out of the repository.
