|
| 1 | +# CLAUDE.md |
| 2 | + |
| 3 | +This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. |
| 4 | + |
| 5 | +## What This Is |
| 6 | + |
| 7 | +A community-maintained list of Australian developer events and meetups. The dataset lives in Markdown files. A static website at `devevents.io` is built from these files using Astro (source in `website/`). |
| 8 | + |
| 9 | +## Website Development |
| 10 | + |
| 11 | +```bash |
| 12 | +cd website |
| 13 | +npm install |
| 14 | +npm run dev # dev server at localhost:4321 |
| 15 | +npm run build # build to website/dist/ |
| 16 | +npm run preview # preview the build |
| 17 | +``` |
| 18 | + |
| 19 | +The website is an Astro 4.x static site with Preact islands for filtering. Data is parsed at build time from the Markdown files. The build runs automatically via GitHub Actions on push to `main` when data files or `website/**` change, deploying to Cloudflare Pages. |
| 20 | + |
| 21 | +## Structure |
| 22 | + |
| 23 | +- `README.md` — upcoming events table (the primary file for new event additions) |
| 24 | +- `Past Events/<year>.md` — events archived by year |
| 25 | +- `Meetups/<state>.md` — recurring meetups by Australian state (ACT, NSW, NT, QLD, SA, TAS, VIC, WA) |
| 26 | +- `CONTRIBUTING.md` — contribution rules |
| 27 | +- `FAQ.md` — project FAQ |
| 28 | + |
| 29 | +## Data Format Rules |
| 30 | + |
| 31 | +When editing the events table, follow these conventions exactly (required for future parsing): |
| 32 | + |
| 33 | +- Dates: `dd-Mmm-yyyy` format (e.g., `01-Jan-2026`). Use `TBC` if unknown. |
| 34 | +- States: `VIC`, `NSW`, `ACT`, `WA`, `SA`, `NT`, `QLD`, `ALL`, `TAS`, `OTH` |
| 35 | +- Events go in **chronological order** within a section |
| 36 | +- No extra spaces or formatting characters in table cells |
| 37 | +- Only Australian-based events of interest to the software development community |
| 38 | +- Links must be verified before adding |
| 39 | + |
| 40 | +## Upcoming vs Past Events |
| 41 | + |
| 42 | +- New events belong in the `README.md` upcoming table |
| 43 | +- When a year ends, its events move to `Past Events/<year>.md` (see the archive commit `fb51c7e` for the pattern) |
| 44 | +- Only active meetup pages are listed; add a link to `README.md` when adding a new state meetup file |
0 commit comments