Introduction
AudienceKit is a generic, multi-tenant system for creating audiences (sub-cultures and communities) and linking them to real-world places and events. Apps are built on top of it: Hot Mess, a guide to queer nights out, is the first and the reference audience.
What’s in the platform
Section titled “What’s in the platform”Everything lives in one repository, audience-kit/audience-kit:
| Component | Path | What it does |
|---|---|---|
| API | api/ |
Rails 8.1 on Ruby 4.0.7 with PostgreSQL/PostGIS and Redis. Serves GraphQL, a REST API under /v1, and Action Cable at /connection. |
| Admin console | admin/ |
React and Relay. Served at admin.<audience domain>, skinned and scoped to that audience. |
| Researcher worker | workers/researcher/ |
A local TypeScript worker that uses a model in LM Studio and Chrome to verify venues and events. |
| Ruby SDK | sdk/ruby/ |
The audience-kit gem. |
| Swift SDK | sdk/swift/ |
The AudienceKit Swift package. |
| These docs | docs/ |
developer.audiencekit.com, built with Astro Starlight. |
How these docs are organized
Section titled “How these docs are organized”- Start here explains the data model and how to run the platform on your machine.
- API covers endpoints, authentication, the GraphQL schema and realtime channels.
- Guides walk through common tasks: theming an audience, connecting a domain, automating with service tokens and deploying.
- SDKs describe the client libraries.