Documentation
Guides, runbooks, and decision records for Event Runner, the white-label event CMS operated by the Center for Cooperative Media.
Every page here is rendered from the Markdown in the repository. The demo site shows what attendees see; the guides below cover running one.
Start here
What Event Runner is, and the plain-language handbook for the people using a site.
- Overview What the product is, what v1 includes, and how a deployment is run.
- Handbook The non-technical guide, split by who you are.
- For clients What a client organization owns, and what CCM operates.
- For event staff Running the site day to day from the admin panel.
- For attendees Signing in, bookmarking sessions, and fixing a profile.
- FAQ Short answers to the questions that come up most.
- Getting help Which door to use for which kind of problem.
- Glossary The words this project uses, defined once.
Operate
The runbooks CCM staff follow to provision, deploy, and hand over a client event.
- Admin guide Running a client site from the admin panel, in the order the work happens.
- Work with sessions in the admin Create, edit, preview, and publish sessions without breaking schedule references.
- Stripe ticketing launch and support Configure organizer-owned payments, verify readiness, and support orders and admission.
- Archive and hand off a past event Export the event data package, back up the project, and keep the past site online read-only.
- Use read-only browser diagnostics Enable, use, and verify bounded public and authenticated site tools.
- Site design reference Every site style, option, layout axis, and token, in full. The deep end.
- Client onboarding The provisioning checklist from first call to handover.
- Deploy runbook Standing up a client Firebase project and shipping to it.
- Postmark provisioning Sender domain, message streams, and webhook cutover.
- Eventbrite verification Verifying the ticketing adapter against a real Eventbrite account.
- npm name claim Claiming and holding the package name.
Build
What contributors need before opening a pull request, and the decisions behind the code.
- Contributing Setup, tests, sign-off, and the proportional CI tiers.
- Code of conduct The behavior expected in every project space, and how to report a problem.
- Governance Who decides what, and how a decision gets made.
- Releasing How a tagged release is cut and what it promises.
- Interface guidelines The interface rules the web app is held to.
- ADR 0001: Event platform v1 The v1 architecture decision record. This is the contract.
- ADR 0003: Optional Google Calendar sync The proposed record that brings calendar sync back as an opt-in, and what a client sets up first.
- Roadmap The five v1 milestones and what is left.
- Changelog What changed, release by release.
Get help
Where to ask, and how to report something that should not be public.