Add CLAUDE.md with project info and deployment instructions
This commit is contained in:
parent
0acc43c95f
commit
164dd269ad
44
CLAUDE.md
Normal file
44
CLAUDE.md
Normal file
@ -0,0 +1,44 @@
|
||||
# RS-UV3A
|
||||
|
||||
Documentation site for the RS-UV3A VHF/UHF transceiver by HobbyPCB.
|
||||
|
||||
- **Production**: https://rs-uv3a.warehack.ing
|
||||
- **Git**: `git@git.supported.systems:RF/rs-uv3a.git`
|
||||
- **Server**: `ssh -A warehack-ing@warehack.ing`, repo at `~/rs-uv3a`
|
||||
|
||||
## Stack
|
||||
|
||||
- Astro/Starlight (static output)
|
||||
- Docker multi-stage build (Node builder -> Caddy prod)
|
||||
- caddy-docker-proxy on external `caddy` network
|
||||
- Makefile with `include .env` for environment-driven dev/prod switching
|
||||
|
||||
## Environment
|
||||
|
||||
Create `.env` in project root:
|
||||
|
||||
```env
|
||||
COMPOSE_PROJECT=rs-uv3a-docs
|
||||
DOMAIN=rs-uv3a.warehack.ing
|
||||
ENVIRONMENT=prod
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
```bash
|
||||
make up # Start services (detached)
|
||||
make down # Stop services
|
||||
make logs # Follow service logs
|
||||
make prod # Switch to prod mode and restart
|
||||
make dev # Switch to dev mode and restart
|
||||
make rebuild # Full rebuild (no cache)
|
||||
make status # Show running containers
|
||||
make clean # Remove containers, images, volumes
|
||||
make help # Show all targets
|
||||
```
|
||||
|
||||
## Deploy to Production
|
||||
|
||||
```bash
|
||||
ssh -A warehack-ing@warehack.ing "cd ~/rs-uv3a && git pull && make up"
|
||||
```
|
||||
Loading…
x
Reference in New Issue
Block a user