Skip to content

Open-source event management and ticket selling platform β€” perfect for concerts, conferences, and everything in between 🎟️ If you find this project helpful, please consider giving us a star ⭐️

Update README.md

Dave Earley68fecd43d7ab
diff --git a/README.md b/README.md
index 686ea980b..38c836bd1 100644
--- a/README.md
+++ b/README.md
@@ -13,8 +13,9 @@ Self-hosted or cloud. Your events, your brand, your data.
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://github.com/HiEventsDev/Hi.Events/blob/develop/LICENCE)
[![GitHub Release](https://img.shields.io/github/v/release/HiEventsDev/hi.events?include_prereleases)](https://github.com/HiEventsDev/hi.events/releases)
-[![Run Unit Tests](https://github.com/HiEventsDev/hi.events/actions/workflows/unit-tests.yml/badge.svg?event=push)](https://github.com/HiEventsDev/hi.events/actions/workflows/unit-tests.yml)
+[![GitHub Stars](https://img.shields.io/github/stars/HiEventsDev/hi.events?style=flat)](https://github.com/HiEventsDev/hi.events/stargazers)
[![Docker Pulls](https://img.shields.io/docker/pulls/daveearley/hi.events-all-in-one)](https://hub.docker.com/r/daveearley/hi.events-all-in-one)
+[![E2E Tests](https://github.com/HiEventsDev/hi.events/actions/workflows/e2e.yml/badge.svg?event=push)](https://github.com/HiEventsDev/hi.events/actions/workflows/e2e.yml)
<a href="https://trendshift.io/repositories/10563" target="_blank">
<img src="https://trendshift.io/api/badge/repositories/10563" alt="HiEventsDev%2Fhi.events | Trendshift" width="250" height="55"/>
@@ -34,7 +35,8 @@ Most ticketing platforms charge per-ticket fees and lock your data into their ec
open-source alternative to Eventbrite, Tickettailor, Dice.fm, and other ticketing platforms** for organizers who want
full control over branding, checkout, data, and infrastructure.
-Built for nightlife promoters, festival organizers, venues, community groups, and conference hosts.
+Trusted by thousands of event organizers worldwide β€” from nightlife promoters and festivals to venues, community groups,
+and conference hosts. Run it yourself, or let us run it for you on Hi.Events Cloud.
<br>
@@ -44,88 +46,29 @@ Built for nightlife promoters, festival organizers, venues, community groups, an
## Features
-<table>
-<tr>
-<td width="50%" valign="top">
+**🎟️ Ticketing & sales** β€” free, paid, donation and tiered tickets Β· recurring and multi-date events Β· sold-out
+waitlists Β· promo codes, including promo-gated and hidden tickets Β· product add-ons and categories Β· tax, fee and
+capacity management
-### 🎟️ Ticketing & Sales
+**🎨 Branding & customization** β€” event homepage designer for cover image, colors and typography Β· branded organizer
+homepage Β· customizable PDF tickets Β· embeddable ticket widget Β· SEO metadata controls
-- Flexible ticket types (free, paid, donation, tiered)
-- Hidden and locked tickets behind promo codes
-- Promo codes and pre-sale access
-- Product add-ons (merch, upgrades, extras)
-- Product categories for organization
-- Full tax and fee support (VAT, service fees)
-- Capacity management and shared limits
+**πŸ‘₯ Attendee management** β€” custom checkout questions Β· advanced search, filtering and CSV/XLSX export Β· full and
+partial refunds Β· bulk messaging Β· QR check-in with scan logs and access-controlled check-in lists
-</td>
-<td width="50%" valign="top">
+**πŸ“Š Analytics & growth** β€” sales dashboard Β· affiliate tracking Β· daily sales, product sales, promo code, revenue and
+tax reports Β· outgoing webhooks
-### 🎨 Branding & Customization
-
-- Beautiful, conversion-optimized checkout
-- Customizable PDF ticket designs
-- Branded organizer homepage
-- Drag-and-drop event page builder
-- Embeddable ticket widget
-- SEO tools (meta tags, Open Graph)
-
-</td>
-</tr>
-<tr>
-<td width="50%" valign="top">
-
-### πŸ‘₯ Attendee Management
-
-- Custom checkout questions
-- Advanced search, filtering, and export (CSV/XLSX)
-- Full and partial refunds
-- Bulk messaging by ticket type
-- QR code check-in with scan logs
-- Access-controlled check-in lists
-
-</td>
-<td width="50%" valign="top">
-
-### πŸ“Š Analytics & Growth
-
-- Real-time sales dashboard
-- Affiliate and referral tracking
-- Advanced reporting (sales, tax, promos)
-- Webhooks (Zapier, Make, CRMs)
-
-</td>
-</tr>
-<tr>
-<td colspan="2" valign="top">
-
-### βš™οΈ Operations
-
-Multi-user roles and permissions Β· Stripe Connect instant payouts Β· Offline payment methods Β· Offline event support Β·
-Automatic invoicing Β· Event archive Β· Multi-language support Β· Full REST API
-
-</td>
-</tr>
-</table>
-
-<br>
-
-## Compare
-
-| Feature | Hi.Events | Eventbrite | Tickettailor | Dice |
-|:---------------------------------|:----------|:-----------|:-------------|:--------|
-| Self-hosted option | βœ… | ❌ | ❌ | ❌ |
-| Open source | βœ… | ❌ | ❌ | ❌ |
-| No per-ticket fees (self-hosted) | βœ… | ❌ | ❌ | ❌ |
-| Full custom branding | βœ… | Limited | βœ… | Limited |
-| Affiliate tracking | βœ… | βœ… | ❌ | ❌ |
-| API access | βœ… | βœ… | βœ… | Limited |
-| Own your data | βœ… | ❌ | ❌ | ❌ |
+**βš™οΈ Operations** β€” multi-user roles Β· Stripe Connect payments Β· offline payment methods Β· automatic
+invoicing Β· online and in-person events Β· multi-language support Β· full REST API with
+[interactive OpenAPI docs](#rest-api)
<br>
## Quick Start
+Built with **Laravel 13** (PHP >=8.3) Β· **React 19** with SSR Β· **TypeScript** Β· **PostgreSQL** Β· **Redis** Β· **Docker**.
+
### One-Click Deploy
[![Deploy on DigitalOcean](https://www.deploytodo.com/do-btn-blue.svg)](https://github.com/HiEventsDev/hi.events-digitalocean)
@@ -153,48 +96,72 @@ Open `http://localhost:8123` and create your account.
πŸ“– [Full installation guide](https://hi.events/docs/getting-started?utm_source=gh-readme)
+### REST API
+
+Hi.Events ships a documented REST API. Set `API_DOCS_ENABLED=true` in your `.env` to serve interactive OpenAPI
+documentation at `/docs/api` on your own instance, or export the spec with:
+
+```bash
+php artisan scramble:export
+```
+
<br>
## Hi.Events Cloud
-Prefer not to self-host? **[Hi.Events Cloud](https://app.hi.events/auth/register?utm_source=gh-readme)** is a fully
-managed option with zero setup, automatic updates, and managed infrastructure.
+Prefer not to self-host? **[Hi.Events Cloud](https://app.hi.events/auth/register?utm_source=gh-readme)** is the fully
+managed version of this repository β€” zero setup, automatic updates and managed infrastructure, run by the team that
+builds Hi.Events.
[Get started β†’](https://app.hi.events/auth/register?utm_source=gh-readme)
<br>
-## Contributing
+## Licensing
-We welcome contributions. See the [contributing guide](CONTRIBUTING.md) for details.
+Hi.Events is licensed under **AGPL-3.0 with additional terms**. The additional terms require the "Powered by Hi.Events"
+attribution to be retained on pages and emails generated by the software β€” see [LICENCE](LICENCE) for the exact wording.
+
+**Commercial licences are available** if you'd like to remove the attribution or need terms that suit a white-labelled
+deployment. [Licensing options](https://hi.events/licensing?utm_source=gh-readme) Β·
<br>
-## Support
+## Contributing
+
+Contributions are welcome β€” see the [contributing guide](CONTRIBUTING.md) to get started. Please open an issue or
+discussion before starting significant work so we can align on the approach. Contributors sign
+a [CLA](CLA.md).
-πŸ“– [Documentation](https://hi.events/docs?utm_source=gh-readme) Β· πŸ“§ [[email protected]](mailto:[email protected]) Β·
-πŸ› [GitHub Issues](https://github.com/HiEventsDev/hi.events/issues)
+<a href="https://github.com/HiEventsDev/hi.events/graphs/contributors">
+ <img src="https://contrib.rocks/image?repo=HiEventsDev/hi.events" alt="Hi.Events contributors" />
+</a>
<br>
-## Changelog
+## Security
-Stay updated with new features and improvements on
-the [releases page](https://github.com/HiEventsDev/hi.events/releases).
+Found a vulnerability? Please report it privately to [[email protected]](mailto:[email protected]) rather than opening
+a public issue. See our [security policy](SECURITY.md).
<br>
-## License
+## Support
+
+πŸ“– [Documentation](https://hi.events/docs?utm_source=gh-readme) Β·
+πŸ› [GitHub Issues](https://github.com/HiEventsDev/hi.events/issues) Β·
+πŸ’¬ [Discussions](https://github.com/HiEventsDev/hi.events/discussions) Β·
-Hi.Events is licensed under **AGPL-3.0 with additional terms**. Commercial licensing
-available. [Learn more](https://hi.events/licensing).
+New features and improvements are listed on
+the [releases page](https://github.com/HiEventsDev/hi.events/releases).
<br>
<div align="center">
-**[Website](https://hi.events)** Β· **[Documentation](https://hi.events/docs)** Β· *
-*[Twitter/X](https://x.com/HiEventsTickets)**
+**[Website](https://hi.events)** Β· **[Documentation](https://hi.events/docs)** Β· **[Cloud](https://app.hi.events/auth/register?utm_source=gh-readme)** Β· **[Licensing](https://hi.events/licensing)**
Made with ☘️ in Ireland