Skip to content

README.md

Latest commit

 

History

History
71 lines (48 loc) · 1.84 KB

README.md

File metadata and controls

71 lines (48 loc) · 1.84 KB
Raw

Clair

Clair is an app for keeping business expenses in one place.

It helps you:

  • add an expense by hand
  • upload a receipt or invoice
  • read the document with OCR
  • review and fix the extracted data
  • save the expense as a record
  • see spending trends over time

Clair has two parts:

  • ios/ for the iPhone app
  • backend/ for the API, database, and file storage

How To Use It

1. Run the backend

The backend runs with Docker Compose.

cd backend
docker compose up --build

This starts the API, the worker, and PostgreSQL.

2. Run the iPhone app

Open ios/Clair.xcodeproj in Xcode and run the Clair scheme.

If you are testing on a real iPhone, the app can use the backend over Tailnet.

3. Add an expense

  • Go to Expenses
  • Tap +
  • Upload a receipt or enter the expense by hand
  • Review the extracted text and fields
  • Save the expense when it looks right

Main Screens

  • Overview shows spend trends and totals.
  • Expenses shows draft and saved expenses.
  • Categories lets you manage expense categories.
  • Draft Expense is where you review an upload or manual draft.
  • Saved Expense is where you edit an expense after saving it.

What Clair Uses

  • Apple Vision OCR on iPhone
  • AI in the backend to turn OCR text into structured expense data like merchant, date, line items, category, subtotal, tax, and total
  • PostgreSQL for storage
  • Alembic for database migrations

More Details

If you want the backend setup details, see backend/README.md.

If you want the product plan and screen designs, see: