Hack Club's Site (v4)

This codebase powers the Hack Club website, which is built with Next.js. You can view it live at hackclub.com

Development

1. Clone the repository

git clone --depth 1 https://github.com/hackclub/site.git

Note

--depth 1 only gets the latest commit, if you need the full history (unlikely, ~562M), remove the --depth.

2. Install the dependencies

bun install

3. Then, start the development server:

bun dev

4. Run the tests with:

bun test

For agents

The site publishes a machine-readable surface alongside the HTML:

URL	What it is
/llms.txt	Index of every page, in the llmstxt.org format
/api/v1/docs	Browsable reference for the Events API
/api/versioning	Public API compatibility, deprecation, and removal policy
/openapi.json, /api/openapi.yaml	OpenAPI 3.2 description of the Events API — the same document is served at /api/v1/openapi.json and /api/v1/openapi.yaml
/api/v1/events/rss	RSS 2.0 feed of newly announced events
/sitemap.xml, /robots.txt	Canonical URLs and crawl rules
<page>.md	Markdown representation of any page (/index.md for the homepage)

Any page also answers Accept: text/markdown with Markdown from the same URL

Credits

Tongyu (@bucketfish) made most of the design with help from Rowan (@3kh0). This is also built with help and feedback from many other Hack Club members! You can join the fun by submitting a pull request!