Update README to reflect current project state

This commit is contained in:
2026-03-12 14:26:13 -06:00
parent 14e1e15226
commit 0bb3ceddf8
+67 -40
View File
@@ -1,38 +1,38 @@
# ezcheck # check-printing
Self-hosted web app for printing checks on blank check stock. Replaces ezCheckPrinting (Halfpricesoft). Self-hosted web app for printing checks on blank check stock. Replaces ezCheckPrinting (Halfpricesoft) — a Windows-only desktop app — with a Dockerized Node.js web app accessible on the local network.
## Stack ## Stack
- **Runtime:** Node.js 20 - **Runtime:** Node.js 20
- **Framework:** Express - **Framework:** Express 4
- **Database:** SQLite via `better-sqlite3` - **Database:** SQLite via `better-sqlite3`
- **PDF generation:** PDFKit with embedded MICR E-13B font - **PDF generation:** PDFKit with embedded GnuMICR E-13B font (GPL-2.0)
- **Frontend:** Vanilla JS, no framework - **Frontend:** Vanilla JS, no framework
- **Container:** Docker Compose - **Container:** Docker Compose pulling from Docker Hub
## Project Structure ## Project structure
``` ```
ezcheck/ check-printing/
├── src/ ├── src/
│ ├── routes/ │ ├── routes/
│ │ ├── checks.js # CRUD for check records │ │ ├── checks.js # CRUD for check records
│ │ ├── accounts.js # Account config (Phase 2)
│ │ └── pdf.js # PDF generation endpoint │ │ └── pdf.js # PDF generation endpoint
│ ├── services/ │ ├── services/
│ │ └── pdfService.js # PDFKit rendering logic │ │ └── pdfService.js # PDFKit rendering, MICR line, amount-to-words
│ ├── db/ │ ├── db/
│ │ ├── schema.sql # SQLite schema │ │ ├── schema.sql # SQLite schema
│ │ └── database.js # DB connection + helpers │ │ └── database.js # DB connection + WAL mode
│ └── app.js # Express app │ └── app.js # Express app, all routes
├── migrations/ ├── migrations/
│ └── import-mdb.js # One-time .mdb import script │ └── import-mdb.js # One-time .mdb → SQLite migration script
├── public/ ├── public/
│ ├── index.html
│ ├── css/style.css │ ├── css/style.css
── js/app.js ── js/app.js
│ └── index.html ├── fonts/
├── fonts/ # MICR E-13B TTF goes here │ └── GnuMICR.otf
├── docker/ ├── docker/
│ └── Dockerfile │ └── Dockerfile
├── docker-compose.yml ├── docker-compose.yml
@@ -40,47 +40,74 @@ ezcheck/
└── .env.example └── .env.example
``` ```
## Getting Started ## Getting started
### Production (Docker)
```bash
cp .env.example .env
# Edit .env with your NTFY_URL if desired
docker compose pull
docker compose up -d
```
On first launch, the app detects no account is configured and opens a **setup wizard** in the browser. Fill in three steps — checkwriter info, bank info, and account/routing numbers — then start entering checks.
If you have an existing ezCheckPrinting `.mdb` file, click **Import .mdb** instead.
### Development (local) ### Development (local)
```bash ```bash
npm install npm install
cp .env.example .env cp .env.example .env
node migrations/import-mdb.js --file /path/to/YourAccount.mdb npm run dev # nodemon src/app.js
npm run dev
``` ```
### Production (Docker) ## Importing from ezCheckPrinting (.mdb)
Two ways to import:
**Via the UI (recommended):** Click **Import .mdb** in the toolbar, select the file, and click Import. The server runs the migration and shows the log output.
**Via CLI** (inside the container or locally with `mdbtools` installed):
```bash ```bash
docker compose up -d docker exec -it check-printing node migrations/import-mdb.js \
--file "/app/data/YourAccount.mdb"
# Preview without writing:
node migrations/import-mdb.js --file YourAccount.mdb --dry-run
``` ```
## Migration The script imports account config (T100), logo (Settings), check layout (T200), and check history (T104).
The import script reads a single `.mdb` file and populates the SQLite database.
It requires `mdbtools` to be installed on the host or available in the container.
```bash
node migrations/import-mdb.js --file "Montana Dinosaur Center.mdb"
```
## Printing ## Printing
- Select 13 checks from the ledger 1. Select 13 checks from the ledger (checkbox column)
- Click "Print PDF" 2. Click **Generate PDF**
- App generates a 3-up 8.5"×11" PDF (three 3.667" check slots) 3. A 3-up 8.5"×11" PDF opens in a new tab — three 3.667" check slots per page
- PDF opens in browser, user sends to printer 4. Print from the browser; checks are marked as printed in the ledger
- Checks are marked as printed in the ledger
## Check Layout Coordinate Space Use the **Reprint** button on printed checks to regenerate without re-marking them.
Coordinates are in inches. Origin is top-left of each check slot. ## Check layout
Check slot dimensions: 8.5" wide × 3.667" tall (three per letter page).
MICR line is hardcoded at Y = 3.4" (0.267" from bottom of slot).
## MICR Font - Page: 8.5" × 11", zero margins
- Three slots of 3.667" each
- MICR line at Y = 3.4" from top of slot (0.267" from bottom)
- MICR format: `A{routing}A {account}C {checkNo}A` (GnuMICR E-13B encoding)
Place `micrenc.ttf` or `GnuMICR.ttf` in the `fonts/` directory. ## CI/CD
Update `MICR_FONT_PATH` in `.env` if using a different filename.
Push to `main` triggers a GitHub Actions workflow that builds a multi-arch Docker image (amd64/arm64) and pushes it to Docker Hub as `dogiakos/check-printing:latest`. An ntfy notification is sent on success or failure.
## Environment variables
See `.env.example`. Key variables:
| Variable | Default | Description |
| -------- | ------- | ----------- |
| `PORT` | `3000` | HTTP port |
| `DB_PATH` | `data/check-printing.db` | SQLite database path |
| `MICR_FONT_PATH` | *(see .env.example)* | Path to GnuMICR.otf inside container |
| `NTFY_URL` | — | ntfy topic URL for push notifications |