README — Job Board, Granite State Mechanical

This is an example. It's the real handover folder for the demonstration project on this site (a fictional 12-person mechanical shop). Names and numbers are sample data; the structure is exactly what you'd receive for a real build. For your project, every line below would be about your system.

What this is

A small job-tracking app that replaced the shop's multi-tab scheduling workbook. It shows the job list, each crew's week, and a one-tap detail view for every job. It does the things the workbook did, without the things the workbook did to you: no merged cells, no broken formulas, no hidden tabs, no copying last week's tab on Monday.

How to run it

It's a static web app — files, not servers.

1. The live copy runs at the address in ACCOUNTS.md, on hosting you own.
2. To run it on any computer: open the app/ folder, install the tools listed in app/README (two commands, both mainstream), and start it. The developer page in MANUAL.md walks through it.

There is no database server, no monthly software license, and no account of mine anywhere in the loop.

Who to call if it breaks

Any developer. That's the point of this folder. Tell them:

"It's a static web app — plain TypeScript, no server, no database. The code is in our account (see ACCOUNTS.md), the build steps are in the app README, and DECISIONS.md explains why it's built the way it is. Start there."

A competent developer will be oriented in under an hour. If it breaks within 60 days of delivery, it's mine to fix, free, with a response within one business day — that's in the contract, not in an email.

What's in this folder

File	What it's for	Written for
README.md	This file — orientation	whoever opens it
MANUAL.md	How to use the app, day to day	the office
ACCOUNTS.md	Every account, domain, and login — who owns what	the owner
DECISIONS.md	Why it's built this way, in plain English	owner + next dev
app/	The source code, buildable as delivered	the next developer