Skip to content

itsjrsa/quicz

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

71 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Quicz

Quick Quiz — a lean, self-hostable live quiz for the room you're already in. One code, one room, no signups.

License: AGPL v3 Node Next.js Docs

▶️ Watch a 90-second demo

video.mp4

Quickstart

cp .env.example .env
docker compose up -d

Open http://localhost:3000. Admin lives at /admin (set ADMIN_PASSWORD first). Participants join with a 6-character code.

Configuration

Variable Required Default Description
ADMIN_PASSWORD Password for the single admin account.
SESSION_SECRET Long random string used to HMAC-sign the admin cookie.
DATABASE_URL ./data/quicz.db Path to the SQLite file.
PORT 3000 HTTP/WebSocket port.

Docs

Full documentation: https://docs.quicz.live/ — why Quicz, local install, usage walkthrough, architecture, data & privacy, roadmap.

Contributor-facing docs stay in the repo:

  • DESIGN.md — authoritative spec: data model, socket events, phase transitions.
  • CONTRIBUTING.md — how to contribute.
  • CLAUDE.md — conventions for AI coding assistants working on this repo.

License

GNU Affero General Public License v3.0 or later. If you modify Quicz and run it as a network service, you must make your source available to its users.

About

Quick Quiz — a lean, self-hostable live quiz for the room you're already in. One code, one room, no signups.

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages