docs(readme): add routing, ranking, database and MinIO setup instructions

Author: Nigma-Ks

README.md

@@ -5,6 +5,21 @@ This project is a **local web application** designed to compare symbolic executi
 
 The system uses **PySymGym tools** to run symbolic execution on the dataset and evaluate the results. After execution completes, the results are sent to the **email address you provide**.
 
+## Features
+
+- **Run Experiment** — upload an ONNX model, select test methods from the dataset, and compare it against the baseline strategy. Results (coverage, errors, timing) are delivered to your inbox.
+- **Model Ranking** — a public leaderboard of all published experiments, sorted by mean coverage. Shows per-experiment metrics: mean/median coverage, total tests, errors, and runtime.
+- **Publish Experiment** — submit a model to the ranking leaderboard. The experiment runs in Docker, computes metrics, and saves the result to the database. Supports cancellation while in progress.
+
+The frontend is a multi-page React SPA using `react-router-dom`:
+
+| Route | Page |
+|---|---|
+| `/` | Home — navigation hub |
+| `/experiment` | Run Experiment form |
+| `/ranking` | Model Ranking leaderboard |
+| `/ranking/publish` | Publish Experiment form |
+
 # Installation
 
 The repository contains **both frontend and backend components**, and **both must be launched** for the application to work.
@@ -13,7 +28,7 @@ The repository contains **both frontend and backend components**, and **both mus
 
 ## Email Communication (Gmail)
 
-To enable email delivery of results, create a `.env` file containing your Gmail credentials:
+To enable email delivery of results, add Gmail credentials to your `.env` file:
 
 ```
 EMAIL=your_email@gmail.com
@@ -25,6 +40,45 @@ APP_PASSWORD=your_app_password
 
 ---
 
+## Database (PostgreSQL)
+
+The ranking leaderboard stores experiment results in a PostgreSQL database. Add the connection URL to your `.env` file:
+
+```
+DB_URL=postgresql://user:password@localhost:5432/pysymbench
+```
+
+The required table is created automatically on server startup. You can run a local PostgreSQL instance via Docker:
+
+```
+docker run --name postgres-pysymbench -e POSTGRES_USER=user -e POSTGRES_PASSWORD=password \
+  -e POSTGRES_DB=pysymbench -p 5432:5432 -d postgres
+```
+
+---
+
+## Object Storage (MinIO) — optional
+
+When publishing experiments to the ranking, the ONNX model and result artifacts can be stored in MinIO. Add the following to your `.env` file:
+
+```
+MINIO_ENDPOINT=localhost:9000
+MINIO_ACCESS_KEY=your_access_key
+MINIO_SECRET_KEY=your_secret_key
+MINIO_SECURE=false
+MINIO_BUCKET=pysymbench
+```
+
+If not configured, artifact upload is skipped and only metrics are saved to the database. You can run a local MinIO instance via Docker:
+
+```
+docker run --name minio -p 9000:9000 -p 9001:9001 \
+  -e MINIO_ROOT_USER=your_access_key -e MINIO_ROOT_PASSWORD=your_secret_key \
+  -d minio/minio server /data --console-address ":9001"
+```
+
+---
+
 ## Backend Setup
 
 1. Install **Python 3.14** and **Docker**, then install the project dependencies:
@@ -62,10 +116,27 @@ celery -A backend.utils.task worker --loglevel=info && uvicorn backend.main:app
 ```
 cd frontend
 npm install
+npm install react-router-dom @types/react-router-dom
 ```
 
 3. Start the frontend development server:
 
+```
+npm run dev
+```
+
+Or build for production:
+
 ```
 npm run build
 ```
+
+### Frontend technology stack
+
+| Package | Purpose |
+|---|---|
+| `react-router-dom` | Client-side routing between pages |
+| `@types/react-router-dom` | TypeScript types for react-router-dom |
+| `antd` | UI component library (forms, tables, buttons) |
+| `tailwindcss` | Utility-first CSS framework |
+| `vite` | Build tool and dev server |