Compare commits

..

7 Commits

Author SHA1 Message Date
Chris Farhood 3604049222 Add .mcp.json
CI / Test (push) Successful in 1m20s
CI / Lint & Typecheck (push) Successful in 1m23s
CI / Build (push) Successful in 31s
CI / E2E Tests (push) Failing after 3m59s
CI / Web E2E (Dev) (push) Has been skipped
CI / Build & Push Docker Images (push) Has been skipped
CI / Deploy PR to groombook-dev (push) Has been skipped
CI / Update Infra Image Tags (push) Has been skipped
2026-05-24 18:14:26 +00:00
Chris Farhood 8f2deaa6d7 Delete opencode.json
CI / Test (push) Successful in 58s
CI / Lint & Typecheck (push) Successful in 55s
CI / Build (push) Successful in 25s
CI / E2E Tests (push) Successful in 2m14s
CI / Build & Push Docker Images (push) Successful in 1m27s
CI / Deploy PR to groombook-dev (push) Has been skipped
CI / Update Infra Image Tags (push) Failing after 0s
CI / Web E2E (Dev) (push) Has been skipped
2026-05-24 18:14:06 +00:00
Scrubs McBarkley 9e8723de57 Merge pull request 'fix(ci): use REGISTRY_TOKEN + E2E DinD networking on main' (#424) from fix/ci-registry-auth-main into main
CI / Deploy PR to groombook-dev (push) Has been skipped
CI / Web E2E (Dev) (push) Has been skipped
CI / Lint & Typecheck (push) Successful in 22s
CI / Test (push) Successful in 24s
CI / Build (push) Successful in 21s
CI / Build & Push Docker Images (push) Has been skipped
CI / Update Infra Image Tags (push) Has been skipped
CI / E2E Tests (push) Failing after 3m32s
fix(ci): use REGISTRY_TOKEN + E2E DinD networking on main

Merging per GRO-1355 org-wide PR backlog cleanup.
2026-05-20 12:10:22 +00:00
Scrubs McBarkley e037748c85 Merge pull request 'docs: archive monorepo and link to successor repos (GRO-1081)' (#411) from archived-readme into main
CI / Lint & Typecheck (push) Successful in 21s
CI / Test (push) Successful in 24s
CI / Deploy PR to groombook-dev (push) Has been skipped
CI / Update Infra Image Tags (push) Has been skipped
CI / Build (push) Successful in 23s
CI / Web E2E (Dev) (push) Has been skipped
CI / E2E Tests (push) Failing after 3m34s
CI / Build & Push Docker Images (push) Has been skipped
docs(GRO-1081): archive monorepo, link to successor repos

Merging per GRO-1355 org-wide PR backlog cleanup.
2026-05-20 12:10:19 +00:00
Chris Farhood 93716afd1a fix(ci): use REGISTRY_TOKEN + E2E DinD networking on main
CI / Update Infra Image Tags (pull_request) Has been skipped
CI / Lint & Typecheck (pull_request) Successful in 24s
CI / Test (pull_request) Successful in 24s
CI / Build (pull_request) Successful in 23s
CI / Build & Push Docker Images (pull_request) Has been skipped
CI / Web E2E (Dev) (pull_request) Has been skipped
CI / E2E Tests (pull_request) Failing after 3m27s
CI / Deploy PR to groombook-dev (pull_request) Has been skipped
- Change Docker login password from gitea.token to secrets.REGISTRY_TOKEN
- Add PLAYWRIGHT_BASE_URL env var for E2E DinD networking
- GRO-1345

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-05-20 10:56:40 +00:00
The Dogfather 503c3dbdbb Merge pull request 'chore: migrate .github/workflows to .gitea/workflows' (#422) from gitea/migrate-workflows into main
CI / Lint & Typecheck (push) Successful in 21s
CI / Test (push) Successful in 23s
CI / E2E Tests (push) Failing after 4m18s
CI / Deploy PR to groombook-dev (push) Has been skipped
CI / Web E2E (Dev) (push) Has been skipped
CI / Build (push) Successful in 22s
CI / Build & Push Docker Images (push) Has been skipped
CI / Update Infra Image Tags (push) Has been skipped
chore: migrate .github/workflows to .gitea/workflows

Migrate all 4 workflow files from GitHub Actions to Gitea Actions:
- ci.yml, promote-prod.yml, promote-to-uat.yml (renamed)
- helm-release.yml (recreated for Gitea Pages)
- Registry: ghcr.io → git.farh.net
- Auth: github-app-token → gitea.token
- API calls: gh CLI / actions/github-script → Gitea REST API

Part of GRO-1315.
2026-05-20 01:34:07 +00:00
Chris Farhood d407b895be docs: archive monorepo and link to successor repos
GRO-1081: Execute groombook/app monorepo decommission

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-05-14 17:39:49 +00:00
4 changed files with 39 additions and 208 deletions
+3 -1
View File
@@ -86,6 +86,8 @@ jobs:
- name: Run E2E tests
run: pnpm --filter @groombook/e2e test
env:
PLAYWRIGHT_BASE_URL: http://host.docker.internal:8080
- name: Upload Playwright report
if: failure()
@@ -149,7 +151,7 @@ jobs:
with:
registry: git.farh.net
username: ${{ gitea.actor }}
password: ${{ gitea.token }}
password: ${{ secrets.REGISTRY_TOKEN }}
- name: Build and push API image
uses: docker/build-push-action@v6
+11
View File
@@ -0,0 +1,11 @@
{
"mcpServers": {
"gitea": {
"type": "http",
"url": "https://git-mcp.farh.net/mcp",
"headers": {
"Authorization": "Bearer ${GITEA_TOKEN}"
}
}
}
}
+25 -200
View File
@@ -1,218 +1,43 @@
# GroomBook
# GroomBook Monorepo — Archived
> **The open-source scheduling and client management platform built specifically for independent pet groomers** — giving you the tools of enterprise software without the enterprise price tag or vendor lock-in.
> **This repository has been archived and replaced by standalone repositories.**
**Built for groomers, not corporations.**
## Successor Repositories
---
## Key Features
**Stop chasing confirmations**
- **Customer portal** — Clients confirm or cancel appointments on their own. Reduce no-shows with an automated waitlist.
**Your calendar, your way**
- **iCal calendar feed** — Push GroomBook appointments directly into Google Calendar or Apple Calendar. No app switching.
**Know every pet at a glance**
- **Client & pet records** — Detailed profiles with grooming history, preferences, and breed-specific notes. Full appointment notes for context on every regular.
- **Quick-find search** — Find clients and pets instantly without digging through spreadsheets.
**Staff access without stress**
- **Role-based access control (RBAC)** — Front desk sees bookings; only you see financials. Right access for every role.
**Everything else**
- **Appointment scheduling** — Calendar management for single or multiple groomers
- **Service management** — Pricing, duration, and service catalog
- **POS & invoicing** — Payments, tips, and receipt generation
- **Automated reminders** — SMS and email notifications
- **Reporting dashboard** — Revenue, utilization, and trend analytics
- **Staff impersonation** — Managers can view the customer portal as any client, with full audit logging and session controls
- **PWA** — Installable on mobile devices, works offline
---
## 🚀 Try the Demo
[**Live Demo**](https://demo.groombook.app) — explore GroomBook without installing anything.
---
## Quick Start
### Docker Compose (recommended for indie groomers)
Run GroomBook on your own hardware in minutes. Everything you need is in the box — no subscription, no vendor lock-in.
```bash
git clone https://github.com/groombook/groombook.git
cd groombook
# Start everything (Postgres + database migrations + API + web UI)
docker compose up --build
```
- **Web UI**: http://localhost:8080
- **API**: http://localhost:3000
The default `docker-compose.yml` sets `AUTH_DISABLED=true` so you can explore the app without configuring an OIDC provider. **Important:** Disable this in any internet-facing deployment.
---
## Tech Stack
| Layer | Technology |
| Repository | Description |
|---|---|
| Backend | [Hono](https://hono.dev/) (TypeScript, Node.js) |
| Frontend | React 19 + Vite + [vite-plugin-pwa](https://vite-pwa-org.netlify.app/) |
| Database | PostgreSQL via [CNPG](https://cloudnative-pg.io/) + [Drizzle ORM](https://orm.drizzle.team/) |
| Auth | OIDC via [Authentik](https://goauthentik.io/) |
| Infra | Kubernetes (namespace: `groombook`), Flux GitOps |
| CI | GitHub Actions (self-hosted `groombook-runners`) |
| [groombook/api](https://github.com/groombook/api) | Hono REST API (TypeScript, Node.js) |
| [groombook/web](https://github.com/groombook/web) | React PWA frontend |
| [groombook/charts](https://github.com/groombook/charts) | Helm charts for Kubernetes deployment |
## Repository Structure
## What Changed
```
groombook/
├── apps/
│ ├── api/ # Hono REST API
│ └── web/ # React PWA
├── packages/
│ ├── db/ # Drizzle schema + migrations
│ └── types/ # Shared TypeScript types
├── .github/
│ └── workflows/ # CI/CD pipelines
└── docker-compose.yml
```
- **Monorepo split complete** — The former `apps/api`, `apps/web`, and `packages/*` are now standalone repos
- **`@groombook/types`** — Inlined directly into `groombook/api` and `groombook/web`
- **E2E testing** — Now via Playwright MCP, no standalone repo needed
- **CI/CD** — Each repo has its own pipeline; see individual repos for status
## Getting Started
## Migration Notes
### Prerequisites
- Node.js >= 20
- pnpm >= 9 (`npm install -g pnpm`)
- Docker & Docker Compose (for local Postgres)
### Local Development
If you were cloning `groombook/groombook` for local development:
```bash
# Clone the repo
git clone https://github.com/groombook/groombook.git
cd groombook
# API
git clone https://github.com/groombook/api.git
cd api && pnpm install && pnpm dev
# Install dependencies
pnpm install
# Start local Postgres
docker compose up postgres -d
# Run database migrations
DATABASE_URL=postgres://groombook:groombook@localhost:5432/groombook pnpm db:migrate
# Start API and Web in parallel
pnpm dev
# Web (in a new terminal)
git clone https://github.com/groombook/web.git
cd web && pnpm install && pnpm dev
```
API will be available at http://localhost:3000
Web will be available at http://localhost:5173
For full Docker Compose setup, see each repo's README.
### Environment Variables
## Archive Info
#### API (`apps/api/.env`)
```env
DATABASE_URL=postgres://groombook:groombook@localhost:5432/groombook
OIDC_ISSUER=https://authentik.example.com
OIDC_AUDIENCE=groombook
CORS_ORIGIN=http://localhost:5173
PORT=3000
```
### Running Tests
```bash
# Unit tests (vitest)
pnpm test
# E2E tests (Playwright) — requires the full Docker Compose stack to be running
docker compose up -d --wait
pnpm --filter @groombook/e2e test
# Open the Playwright UI (interactive test runner)
pnpm --filter @groombook/e2e test:ui
# View the last E2E test report
pnpm --filter @groombook/e2e test:report
```
E2E tests target the Docker Compose stack (`http://localhost:8080`). They use API route mocking where needed so happy-path tests are deterministic without requiring seed data.
### Building
```bash
pnpm build
```
## Self-Hosting
### Production Configuration
Copy `.env.example` to `.env` and configure:
```bash
cp .env.example .env
```
Key variables to update for production:
| Variable | Description |
|---|---|
| `DATABASE_URL` | PostgreSQL connection string |
| `AUTH_DISABLED` | Set to `false` in production |
| `OIDC_ISSUER` | Authentik issuer URL |
| `OIDC_AUDIENCE` | OAuth2 audience (default: `groombook`) |
| `CORS_ORIGIN` | Public URL of the web frontend |
To use your `.env` file with Docker Compose:
```bash
docker compose --env-file .env up --build
```
### Kubernetes (production-grade deployments)
See the [groombook/infra](https://github.com/groombook/infra) repository for Kubernetes manifests and Flux configuration.
Groom Book is deployed in the `groombook` Kubernetes namespace using:
- **CNPG** for PostgreSQL
- **Authentik** for OIDC authentication
- **Flux** for GitOps-managed deployments
This repository was archived on 2026-05-14 as part of the monorepo decommission ([GRO-1081]).
The history is preserved but the repo is read-only.
---
## Contributing
GroomBook thrives on contributions from the grooming community. Whether you're a groomer with a feature request, a developer fixing a bug, or someone improving docs — we'd love your help.
1. Fork the repository
2. Create a feature branch (`git checkout -b feature/my-feature`)
3. Commit your changes
4. Open a pull request
All PRs require CI to pass before merge. See [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
---
## Why GroomBook?
- **Open source** — You own your data. No vendor lock-in.
- **Purpose-built** — Features designed for grooming workflows, not generic scheduling.
- **Self-hosted or managed** — Run it yourself for free, or pay for hosted support (coming soon).
- **Community-driven** — Used and built by actual groomers.
---
## License
AGPL-3.0
*For Kubernetes deployments, see [groombook/infra](https://github.com/groombook/infra) (private).*
-7
View File
@@ -1,7 +0,0 @@
{
"$schema": "https://opencode.ai/config.json",
"permission": "allow",
"experimental": {
"snapshots": false
}
}