Newcomer onboarding

From zero to a running doc.haus checkout: what the product is, how to boot it, how to contribute, and which rules govern every change.

Start locally

Install Git and Bun 1.4.0 or newer, clone this repository, then run:

git clone https://github.com/sure-scale/doc-haus.git
cd doc-haus
./start.sh

The launcher installs frozen dependencies and opens the web app at http://localhost:5174. It runs engine, ingest and web on separate local ports. A new installation needs no credentials to boot. Accept the launch notice, choose a provider (detected options appear first), connect with its offered sign-in method and detected defaults, then confirm primary/fast models in setup. Research and firm or jurisdiction details are optional. Opening setup does not make a paid model request; connection tests run only when requested. Provider access and quota remain subject to the provider's account and organization policies.

Install Deno 2 for the shipped Python tool. For document conversion, install Python 3, Poppler, Tesseract and LibreOffice Writer as needed. The container includes these tools. See setup.