huddlz is a service that helps organizers and communities bring people together in person. This repository contains the application source and documentation for contributors and readers.
- Vision describes the project's purpose, values, and goals.
- Domain model and access rules documents the domain model and permissions.
- Email notifications specifies notification categories, triggers, and delivery rules.
- Discovery API documents discovery ordering.
- API follow-ups records deferred work for the JSON:API and GraphQL surfaces.
- Testing explains the project's test-first development approach.
- Commit style contains the commit-message guidelines.
Install vips and the language runtimes defined in
.mise.toml, then run:
mise install
mix setup
mix phx.servermix setup creates local environment files from the checked-in examples when
needed. Run the test suite with mix test.
Groups can connect a Slack or Discord channel for huddlz to post to. That
needs an app registered on each platform; scripts/social_setup.sh walks
through both consoles and records the client ids and secrets for development
(.dev.env) or production (Fly secrets).
We use Matt Pocock's skills in huddlz. If you work with a coding agent, follow his installation guide to install the skills for your agent. The skills aren't bundled in this repo; our project-specific guidance lives in AGENTS.md.
The source is licensed under the Business Source License 1.1. Review the license for the applicable use restrictions and change-license terms.