Skip to content
Projects

yaojingang/TokEMS has 78 GitHub stars and 28 forks. GitHot measured 0 stars in 24 hours. Last checked 2026-11-17 04:31 UTC. Last push 2026-11-14.

How these counts are measured

Measured star growth

in 24h
0
in 7 days
Collecting history
in 15 days
Collecting history
in 1 month
Collecting history

Net star changes over overlapping periods, not daily totals. Missing measurements are left blank. Stars measure attention, not software quality.

About

开源、自托管的一体化大会运营平台,贯通官网、报名、票务、订单、发票、通知与现场签到 | Open-source, self-hosted conference operations platform

Self-hosted

README.en.md

Original

TokEMS

简体中文 | English

License: AGPL v3 CI Status: Public Preview

An open-source, self-hosted conference operations platform for event websites, registration, ticketing, orders, invoicing, notifications, and check-in.

TokEMS is built for conference organizers, operations teams, and event technology providers. It brings content publishing, attendee journeys, transactions, on-site delivery, organization permissions, and audit records into one system.

v0.1.0 is an early preview for local evaluation, customization, and pre-production validation. Production deployments require region-specific security, compliance, payment, messaging, backup, and monitoring configuration. The admin console is currently Simplified Chinese-first, with English support on the near-term roadmap.

Project overview

TokEMS covers the conference journey from content publishing to on-site verification. The public site handles content and registration, the API owns business state such as organizations, inventory, orders, and tickets, and the Worker runs notifications, waitlist jobs, exports, and other asynchronous work.

The full visual report covers use cases, system design, technology, product areas, security controls, deployment, and the internationalization roadmap. It is a self-contained HTML file that can be downloaded, opened locally, or printed to PDF.

Where it fits

Scenario What TokEMS provides
Medium and large conferences One workflow for the event site, registration, paid tickets, notifications, invoicing, and check-in
Organizers running many events Multi-organization isolation, fine-grained RBAC, reusable templates, rollback, and audit records
Event technology providers Self-hosted deployment, modular applications, shared contracts, and payment or messaging boundaries
Busy or unreliable venues Device tokens, QR verification, duplicate detection, offline batch sync, and multi-device testing

Current project size

These numbers come from docs/generated/project-inventory.json and are checked by pnpm docs:check.

Public pages Admin views API controllers API operations Database tables Migrations Test files
16 38 32 266 78 58 154

End-to-end workflow

flowchart LR
    Publish["Publish content"] --> Reach["Reach attendees"]
    Reach --> Register["Registration and eligibility"]
    Register --> Reserve["Inventory hold"]
    Reserve --> Commerce["Order and payment"]
    Commerce --> Deliver["Ticket, invoice, and notification"]
    Deliver --> CheckIn["On-site check-in"]
    CheckIn --> Audit["Audit and review"]

System architecture

flowchart TB
    subgraph Experience["Experience layer"]
        Web["Public Web<br/>Nuxt 4 + Vue 3"]
        Admin["Admin Console<br/>Vue 3 + Vite"]
    end

    Gateway["Nginx Gateway"]
    API["NestJS 11 Modular Monolith API"]
    PostgreSQL[("PostgreSQL 16 + pgvector")]
    Outbox["Transactional Outbox"]
    Queue["Redis + BullMQ"]
    Worker["Worker"]
    Integrations["MinIO / Email / Payment / Regional Services"]

    Web --> Gateway
    Admin --> Gateway
    Gateway --> API
    API --> PostgreSQL
    API --> Outbox
    Outbox --> Queue
    Queue --> Worker
    Worker --> Integrations

Immutable release snapshots keep public content stable while ticket inventory stays live. Locks, signatures, hashes, time windows, and idempotency keys protect order holds, payment callbacks, waitlist claims, and offline check-in.

Features

Area Available today
Event website Template-driven pages, release snapshots, schedules, speakers, ticket types, FAQ, registration, attendee account, and responsive layouts
Registration Versioned forms and terms, inventory holds, idempotent registration, protected order access, payment callbacks, refunds, and digital tickets
Waitlist Sellout queue, ordered invitations, timed inventory holds, single-use purchase tokens, and automatic expiry
Admin console Events, templates, users, registrations, orders, invoices, notifications, system settings, release rollback, and audit management
Templates Structured and HTML templates, shared drafts, immutable versions, image assets, upgrades, and release snapshots
Invoicing Requests, billing details, review, issuance, file delivery, cancellation, refund adjustments, and asynchronous export
On-site operations Device enrollment, device tokens, QR check-in, offline batch sync, and duplicate check-in detection
Platform Multi-organization isolation, fine-grained RBAC, Outbox delivery, rate limits, object storage, Swagger, and audit logs

Technology

  • Web: Nuxt 4 and Vue 3
  • Admin: Vue 3 and Vite
  • API: NestJS 11, Fastify, and Zod
  • Worker: BullMQ and Redis
  • Data: PostgreSQL 16, pgvector, and Drizzle ORM
  • Infrastructure: Docker Compose, Nginx, MinIO, and Mailpit
  • Tooling: TypeScript, pnpm, Turborepo, Vitest, and Playwright

Repository layout

apps/
  web/        Public event site, registration, orders, tickets, and attendee account
  admin/      Conference operations console
  api/        REST API and Swagger documentation
  worker/     Notifications, waitlist jobs, asset tasks, and asynchronous exports
packages/
  contracts/  Zod contracts, TypeScript types, and demo data
  database/   Drizzle schema, SQL migrations, and seeds
  html-template/ HTML template parsing, validation, and publishing
  integrations/  Payment and notification integrations
  security/   Sessions, CSRF, OTP, and encrypted integration credentials
  ui/         Shared design tokens
docs/         Architecture, API, operations, and internationalization documents
tooling/      Deployment, acceptance, and data maintenance scripts

Run locally

Requirements: Node.js 24+, pnpm 11+, and Docker Desktop.

pnpm install
pnpm docker:deploy

The deployment command builds the application images, starts dependencies, applies database migrations, seeds demo data, and runs service-level checks. Default services bind to loopback addresses only.

Service URL
Event website http://localhost:8088
Admin console http://admin.localhost:8088/admin/login
API http://localhost:8088/api/v1
Swagger http://localhost:8088/api/docs
MinIO Console http://localhost:19001
Mailpit http://localhost:8025

Local admin credentials:

Username: admin
Password: admin

The public site accepts any valid mainland China mobile number with the fixed code 123456 in local mode. These simplified credentials only work with DEPLOYMENT_MODE=local. Production mode rejects local authentication and simulated payments.

To change ports or local settings:

cp .env.example .env
pnpm docker:deploy

For source development, run pnpm dev. The web app, admin console, and API listen on localhost:3000, localhost:3200/admin/, and localhost:4100 by default.

Commands

pnpm check                 # Lint, types, tests, builds, and documentation inventory
pnpm audit:security        # Audit high-severity dependency issues
pnpm docker:verify         # Verify container services
pnpm test:persistent       # Verify persistent business workflows
pnpm test:operations       # Verify admin and release workflows
pnpm test:waitlist         # Verify waitlist and inventory handoff
pnpm test:checkin-load     # Verify concurrent device check-in
pnpm test:visual           # Verify key desktop and mobile flows

Internationalization status

TokEMS is intended for conference teams worldwide. The v0.1.0 interface is primarily Simplified Chinese, and the first payment, SMS, and mobile number flows target mainland China. The admin console will support zh-CN and en-US first. Event websites, notification templates, time zones, currencies, addresses, and regional integrations will follow.

See the internationalization roadmap for scope and release gates.

Production checklist

  • Replace database, Redis, object storage, session, and encryption secrets from .env.
  • Disable simplified authentication, fixed verification codes, and simulated payments.
  • Configure HTTPS, trusted proxies, persistent backups, monitoring, and alerts.
  • Review privacy, payment, tax, messaging, and data residency requirements for each deployment region.
  • Back up the database and apply versioned migrations in order before upgrades.

See the operations guide for deployment details.

Documentation

Contributing

Use GitHub Discussions for deployment and usage questions. Read the support guide, contributing guide, and Code of Conduct before opening an issue or pull request. Report security issues privately by following the security policy.

License

TokEMS is licensed under the GNU Affero General Public License v3.0 only. If you provide a modified TokEMS service over a network, the license requires you to offer the corresponding source code to its users.