Skip to main content
On first launch, the app automatically seeds 50 sample businesses with three risk evaluations each. You do not need to add any data manually to explore the full interface.

Start the app

1

Build and run the application

Choose the Docker path (recommended) or run locally with Python.
docker build -t risk-monitor .
docker run -p 8000:8000 risk-monitor
Docker requires no local Python environment and matches the production configuration exactly. Use the local Python path if you want live-reload during development.
2

Open the business list

Navigate to http://localhost:8000 in your browser. You will be redirected to /businesses, which shows the full list of seeded businesses. You can filter by name, industry, country, or date range, and sort by any column.
3

Run your first risk evaluation

Click any business in the list to open its detail page, then click Evaluate Risk. The engine calculates a score from 0–100 based on industry and country modifiers and returns a risk level: low, medium, high, or critical. Each evaluation is saved to the business’s history.
4

Run the test suite in-browser

Navigate to http://localhost:8000/test. The page loads instantly with a spinner, then streams the full pytest output once the suite completes. Tests run against a separate test_risk_monitor.db database and do not affect your seed data.

What’s running

After startup you have access to:
URLDescription
http://localhost:8000/businessesBusiness list with filtering and sorting
http://localhost:8000/businesses/{id}Business detail with latest risk evaluation
http://localhost:8000/testIn-browser test runner
http://localhost:8000/docsAuto-generated OpenAPI documentation

Next steps

Businesses

Learn how to add, filter, and manage businesses in the registry.

Risk evaluation

Understand the scoring model and what each risk level means.

API reference

Explore every endpoint with parameters and example responses.

Filtering and sorting

Use query parameters and HTMX-powered controls to narrow results.

Build docs developers (and LLMs) love