Skip to main content

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 is an educational platform designed for students who want to strengthen their skills in logic, mathematics, physics, chemistry, and programming. It combines a FastAPI backend with a Flet-based Python desktop application to deliver interactive quizzes, instant feedback, and progress tracking — all running locally or deployed in the cloud.

Quickstart

Get LogiMath running in minutes with Docker Compose

Prerequisites

What you need before you start

API Reference

Explore the REST API endpoints

Architecture

Understand how the backend, frontend, and database fit together

What LogiMath offers

LogiMath covers five subject areas — logic, mathematics, physics, chemistry, and programming — through a quiz-based learning format. Students register, browse quizzes by subject and difficulty, answer questions, and receive immediate scoring feedback.

Interactive quizzes

Quizzes span multiple subjects and difficulty levels, with per-question feedback and scoring

Progress tracking

UserScore records track every completed quiz, enabling students to monitor their improvement over time

REST API

A FastAPI backend exposes users, quizzes, and questions — fully documented with Swagger at /docs

Docker-ready

A single docker-compose up --build spins up the backend and PostgreSQL database together

How it works

1

Register or log in

Create a user account through the Flet desktop app or directly via the API. Your profile stores your name, email, and quiz history.
2

Browse quizzes

Quizzes are organized by subject (logic, math, physics, chemistry, programming) and difficulty level. Pick one from the home screen.
3

Answer questions

Each quiz presents a series of questions. Submit your answers to receive an immediate score and feedback.
4

Track your progress

Every completed quiz is stored as a UserScore record. Review your history to see how your performance evolves over time.

Project structure

LogiMath is split into two main components:
  • Backend (src/BackEnd/) — A FastAPI application (mainApi.py) backed by PostgreSQL via SQLAlchemy. Exposes REST endpoints for users, quizzes, and questions.
  • Frontend (src/FrontEnd/) — A Flet Python desktop application (mainApp.py) with login, registration, and home screens.
Both services are orchestrated with Docker Compose, making local development and team collaboration straightforward.
The Swagger UI auto-generated by FastAPI is available at http://localhost:8000/docs when the backend is running. Use it to explore and test all API endpoints interactively.

Build docs developers (and LLMs) love