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.
LogiMath runs as three coordinated services — a FastAPI backend, a Flet frontend, and a PostgreSQL database. Before starting, copy .env.example to .env in the project root and fill in your values; without this file neither the Docker nor the manual setup will connect to the database.
Your .env file must never be committed to version control. It is already listed in .gitignore. The required format for the database connection string is:DATABASE_URL=postgresql://logmath_user:logmath_pass_change_me_in_production@postgres:5432/logmath_db
Choose your setup method
Docker (recommended)
Without Docker
Docker Compose is the recommended approach for team development because it starts the backend and database together and keeps every developer on an identical environment. The Flet frontend runs directly on your host machine alongside the Docker services.Prerequisites: Docker Desktop installed and running, plus Git.Clone the repository and create your .env file
git clone https://github.com/whitiue/logiMathApp.git LogiMath
cd LogiMath
cp .env.example .env
.env and set a strong value for POSTGRES_PASSWORD. Leave @postgres:5432 in DATABASE_URL unchanged — that hostname resolves inside the Docker network.Build and start all services
docker-compose up --build
src/BackEnd/Dockerfile and pulls postgres:16-alpine. On the first run this may take a few minutes.Expected output once all services are healthy:logmath_backend | INFO: Started server process
logmath_db | LOG: database system is ready to accept connections
Verify services are running
Open a second terminal and check container status:The backend is available at http://localhost:8000. To view logs for a specific service:docker-compose logs backend
docker-compose logs postgres
Stop the services
# Stop containers, keep database volume
docker-compose down
# Stop containers and delete the database volume
docker-compose down -v
down -v only when you want to reset the database to a clean state.docker-compose.yml. See the Without Docker tab for frontend setup instructions.The docker-compose.yml does not include a frontend service. The Flet desktop app must be run directly with python mainApp.py from src/FrontEnd/, connecting to the backend at http://localhost:8000.
Run each service in its own terminal. This approach is faster for individual development but requires a reachable PostgreSQL instance.Prerequisites: Python 3.9 or higher and a running PostgreSQL server.Backend
Create a virtual environment and install dependencies
cd src/BackEnd
python -m venv venv
source venv/bin/activate # Windows: venv\Scripts\activate
pip install -r requirements.txt
requirements.txt installs: fastapi==0.136.1, uvicorn[standard]==0.32.0, sqlalchemy==2.0.49, psycopg2-binary==2.9.12, pydantic==2.13.3, and python-dotenv==1.2.2.Set environment variables
Export the required variables in the same terminal session:export DATABASE_URL=postgresql://logmath_user:logmath_pass_change_me_in_production@localhost:5432/logmath_db
export API_HOST=0.0.0.0
export API_PORT=8000
localhost here, not postgres (which is a Docker service name). Start the backend server
uvicorn mainApi:app --reload --host 0.0.0.0 --port 8000
http://localhost:8000. The --reload flag restarts the server whenever you save a Python file.Frontend
Open a new terminal for the frontend:Create a virtual environment and install dependencies
cd src/FrontEnd
python -m venv venv
source venv/bin/activate # Windows: venv\Scripts\activate
pip install -r requirements.txt
requirements.txt installs: flet==0.85.1, requests==2.31.0, and python-dotenv==1.0.0.Run the frontend application
The Flet application window opens on your desktop. It reads API_HOST and API_PORT from your environment or .env file to locate the backend. Running the frontend inside Docker requires a display server (DISPLAY environment variable). If you see a DISPLAY not set error, run the frontend directly with python mainApp.py as shown above.
