`README.md`

49 lines
# Project: Animals

Compliance-first directory + monetization platform for the U.S. animal-care
ecosystem (vets, clinics, breeds, breeders, shelters, groomers, trainers).

Mirrors the proven architecture of `lawyer-directory-builder` and
`professional-directory` — Postgres schema, Express viewer, pm2 workers,
site-audit + mockup + upgrade-order rails, lead funnel, ad engine.

See `PLAN.md` and `docs/monetization.md` for the full design.

## Quick start

```sh
cp .env.example .env          # fill in DATABASE_URL etc.
createdb animals_directory
npm install
npm run migrate
npm run seed:sources
npm run seed:breeds
npm run server                # localhost:9720
```

## Layout

```
src/
  server/      Express app + admin + public routes
  scripts/     migrate, seed, stats, domain research
  ingest/      state vet boards, AAHA, Petfinder, AKC
  enrich/      geocode, website discovery, contacts
  audit/       site_audit + mockup generator (Playwright)
  monetize/    ad engine, lead matching, upgrade flow
  lib/         pg pool, logger, utils
  sources/     per-source scraper modules
migrations/    SQL migrations
public/        static assets, screenshots, mockups
docs/          monetization.md, domain_research.json (generated)
```

## pm2

```sh
npm run pm2:start && pm2 save
```

Apps: `animals-viewer:9720`, `animals-ingest:9721`, `animals-audit:9722`,
`animals-leads:9723`.