Add CLAUDE.md with project info and deployment instructions
This commit is contained in:
parent
f9153af769
commit
62af53c9d1
43
CLAUDE.md
Normal file
43
CLAUDE.md
Normal file
@ -0,0 +1,43 @@
|
||||
# mcNanoVNA Docs
|
||||
|
||||
Documentation site for mcNanoVNA — MCP server for NanoVNA vector network analyzer control.
|
||||
|
||||
- **Production**: https://mcnanovna.warehack.ing
|
||||
- **Git**: `git@git.supported.systems:RF/mcnanovna-docs.git`
|
||||
- **Server**: `ssh -A warehack-ing@warehack.ing`, repo at `~/mcnanovna-docs`
|
||||
|
||||
## Stack
|
||||
|
||||
- Astro/Starlight (static output)
|
||||
- Docker multi-stage build (Node builder -> Caddy prod)
|
||||
- caddy-docker-proxy on external `caddy` network
|
||||
- Separate `docker-compose.dev.yml` for development overlay
|
||||
|
||||
## Environment
|
||||
|
||||
Copy `.env.example` to `.env`:
|
||||
|
||||
```env
|
||||
COMPOSE_PROJECT=mcnanovna-docs
|
||||
DOMAIN=mcnanovna.warehack.ing
|
||||
MODE=prod
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
```bash
|
||||
make up # Start production (static Caddy server)
|
||||
make dev # Start development (Vite hot-reload)
|
||||
make down # Stop all containers
|
||||
make logs # Follow container logs
|
||||
make build # Build production image
|
||||
make rebuild # Force rebuild (no cache)
|
||||
make shell # Open shell in running container
|
||||
make clean # Remove containers, images, volumes
|
||||
```
|
||||
|
||||
## Deploy to Production
|
||||
|
||||
```bash
|
||||
ssh -A warehack-ing@warehack.ing "cd ~/mcnanovna-docs && git pull && make up"
|
||||
```
|
||||
Loading…
x
Reference in New Issue
Block a user