James Griffin
668397104a
Disables dependency lifecycle scripts by default via .npmrc (ignore-scripts=true) so arbitrary packages cannot execute code at install time. An explicit allowlist in web/package.json opts specific packages back in, and CI/Docker/Taskfile now run allow-scripts after npm install to apply it. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
walkies
A web-based application for an animal shelter to manage volunteer scheduling, time off, check-in/check-out, and notifications.
Requirements
- Go 1.25+
- Node.js 22+
- MySQL 8.0
- Task (
brew install go-taskor see install docs) - Docker (optional, for containerised deployment)
Development
Run task to list all available tasks.
Quick start (two terminals)
Terminal 1 — backend:
task web:build # build frontend once so the Go server has static files
task go:run # starts API server on :8080
Terminal 2 — frontend dev server:
task web:dev # hot-reload dev server on :3000, proxies /api/v1 → :8080
Then open http://localhost:3000.
With live backend reload
Install air for hot-reloading the Go server:
go install github.com/air-verse/air@latest
task web:build
task dev:backend
Common tasks
| Task | Description |
|---|---|
task build |
Build frontend and Go binary |
task go:test |
Run Go tests |
task web:test |
Run frontend tests |
task go:lint |
Run go vet |
task tidy |
Tidy Go modules |
task clean |
Remove build artifacts |
Docker
task docker:up # build image and start container
task docker:logs # tail logs
task docker:down # stop
Configuration
The server is configured via environment variables:
| Variable | Default | Description |
|---|---|---|
PORT |
8080 |
HTTP listen port |
DB_HOST |
localhost |
MySQL host |
DB_PORT |
3306 |
MySQL port |
DB_USER |
root |
MySQL username |
DB_PASSWORD |
(empty) | MySQL password |
DB_NAME |
walkies |
MySQL database name |
JWT_SECRET |
change-me-in-production |
HMAC signing key — change this |
STATIC_DIR |
./web/dist |
Path to compiled React app |
Copy .env.example to .env to set these locally (the server reads environment variables directly; use a process manager or Docker to inject them).