Files
romhack-archive-site/README.md
T

40 lines
987 B
Markdown

# ROM Hack Archive
Private Astro site for browsing ginnoir's Pokémon ROM-hack catalog.
The source catalog is a snapshot exported from the Obsidian vault into
`data/catalog.json`. The Pokémon tooling repo still owns catalog refresh scripts;
this repo owns the browsable static site and deployment to
`https://romhacks.ginnoir.com`.
## Develop
```powershell
npm install
npm run dev
```
## Build And Test
```powershell
npm run check
npm run build
npm run test:ui
```
`npm run build` runs `scripts/prepare-site-assets.mjs` first. That step validates
the catalog, downloads banner art into `public/assets/banners/`, and refreshes
generated banner/file manifests from `data/catalog.json` and `data/scrape_lib/`.
## Deploy
The site is served internally by Caddy from `/config/caddy/site/romhacks-wiki`.
```powershell
npm run build
powershell -File scripts/deploy-site.ps1
```
ROM and related-file links point at the internal-only file server:
`https://romhacks-files.ginnoir.com`.