Skip to content
Docs

Project structure

pethealth/
├── Dockerfile               # multi-stage: build the frontend → serve it from Express
├── docker-compose.yml       # build-from-source setup with every env var
├── .env.example
├── .github/workflows/ci.yml # tests, build and Docker smoke test
├── docs/                    # API reference, screenshots
├── backend/                 # Node.js 20 + Express + better-sqlite3
│   ├── src/
│   │   ├── index.js         # starts the server, backup and email schedulers
│   │   ├── app.js           # Express app: middleware, routes, SPA, error handler
│   │   ├── config.js        # environment variables and data paths
│   │   ├── db.js            # schema, versioned migrations (PRAGMA user_version), triggers
│   │   ├── seed.js          # demo pets
│   │   ├── access.js        # owner / editor / viewer checks per pet
│   │   ├── session.js       # JWT + httpOnly cookie for /uploads
│   │   ├── reminders.js     # due items shared by dashboard, email and calendar
│   │   ├── notify.js        # daily email digest (nodemailer)
│   │   ├── ics.js           # iCalendar feed builder
│   │   ├── backup.js        # scheduled SQLite snapshots (`npm run backup`)
│   │   ├── files.js         # upload validation, random names, safe deletion
│   │   ├── validate.js      # shared input validation
│   │   ├── middleware/auth.js
│   │   └── routes/          # auth, users, pets, checkups (+ medications, doses), exams,
│   │                        # vaccines, parasites, conditions, weights, vets, reminders,
│   │                        # calendar, transfer (export/import), attachments
│   └── test/                # node:test + supertest
└── frontend/                # React 18 + Vite
    └── src/
        ├── App.jsx          # routes
        ├── api.js           # axios client
        ├── translations.js  # every UI string, ES and EN
        ├── index.css        # design tokens and component styles (light/dark)
        ├── context/         # auth, language, theme, feedback (dialogs/toasts)
        ├── pages/           # Login, Dashboard, PetProfile, PetReport, AddPet, AddCheckup,
        │                    # AddExam, Account, Vets
        ├── components/      # cards, lists, panels, charts, forms
        └── utils/           # pure helpers + Vitest tests

Design notes

Section titled “Design notes”
  • One process, one file. Express serves the API under /api, protected uploads under /uploads, and the built SPA for everything else. SQLite runs in WAL mode with foreign keys on.
  • Access control in one place. Every route loads its record through access.js, which resolves the pet and the user’s role. Records you can’t see answer 404, so their existence isn’t leaked.
  • Migrations are an ordered list in db.js. Each one runs once inside a transaction, and PRAGMA user_version records the current version.
  • Reminders have a single source (reminders.js) used by the dashboard API, the email digest and the calendar feed.
  • i18n: all UI text lives in translations.js (es and en objects with the same keys). Server log messages are in Spanish.