Add README and operator checklist for Hetzner + Cloudflare + Gitea setup
This commit is contained in:
44
README.md
Normal file
44
README.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# cameleer-website
|
||||
|
||||
Marketing site for [cameleer.io](https://www.cameleer.io) — zero-code observability for Apache Camel.
|
||||
|
||||
This is a **static** Astro 5 site. Hosted on Hetzner Webhosting L, fronted by Cloudflare, deployed via Gitea Actions.
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
npm ci
|
||||
npm run dev # http://localhost:4321
|
||||
npm run test # vitest — auth config + middleware header tests
|
||||
npm run build # produces dist/
|
||||
npm run preview # serves dist/
|
||||
```
|
||||
|
||||
## Quality gates (run in CI)
|
||||
|
||||
```bash
|
||||
npm run lint:html # html-validate on dist/
|
||||
npm run lint:links # linkinator on dist/
|
||||
npm run lh # Lighthouse CI (>=0.95 on all 4 categories)
|
||||
```
|
||||
|
||||
## Environment variables
|
||||
|
||||
See `.env.example`. All are `PUBLIC_*` (build-time, embedded in HTML).
|
||||
|
||||
| Var | Purpose |
|
||||
|-----|---------|
|
||||
| `PUBLIC_AUTH_SIGNIN_URL` | Logto sign-in URL (redirected to by "Sign in" buttons) |
|
||||
| `PUBLIC_AUTH_SIGNUP_URL` | Logto sign-up URL (redirected to by "Start free trial") |
|
||||
| `PUBLIC_SALES_EMAIL` | Sales email (`mailto:` target for "Talk to sales") |
|
||||
|
||||
## Deployment
|
||||
|
||||
Push to `main` → Gitea Actions runs tests, builds, lints, then `rsync`s `dist/` to Hetzner over SSH (ed25519 key, host-key-pinned). Rollback is `git revert && git push`.
|
||||
|
||||
See [`OPERATOR-CHECKLIST.md`](./OPERATOR-CHECKLIST.md) for the one-time Hetzner + Cloudflare setup.
|
||||
|
||||
## Design & plan
|
||||
|
||||
- `docs/superpowers/specs/2026-04-24-cameleer-website-design.md` — the approved spec.
|
||||
- `docs/superpowers/plans/2026-04-24-cameleer-website.md` — the implementation plan that built this repo.
|
||||
Reference in New Issue
Block a user