castro

Note

This project is work in progress. Expect breaking changes.

A static forum archive viewer built with Astro. Point it at a folder of JSON data and it generates a browsable, searchable archive of forums, threads, and member profiles.

🌈 Example Forum

Prerequisites

• Node.js v24+
• pnpm

If you use mise, the included mise.toml handles both.

Installation

Use this repository as a template, then install dependencies:

pnpm install

Data

Provide a data/ folder created with fidel, a scraping tool for the Winamp forum and possibly other vBulletin-based forums. Alternatively, provide data that conforms to the file-structure and JSON Schema.

Configuration

Edit astro.config.mjs to set your site title and optional meta tags:

export default defineConfig({
	integrations: [
		castro({
			title: 'My Forum Archive',
			description: 'An archive of the old forum',
			keywords: ['forum', 'archive'],
			githubPages: true,
		}),
		// Your custom Astro config
	],
});

Development

pnpm dev        # start dev server
pnpm build      # build static site + search index
pnpm preview    # preview the build locally

Deployment

The included githubPages() helper auto-configures site and base when running in GitHub Actions. For other platforms, set these in astro.config.mjs directly.

License

This work is licensed under the MIT License.