Skip to content

docVoid/OpenLiQ

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenLiQ

OpenLiQ-Logo

OpenLiQ is a lightweight, local multiplayer quiz platform. Hosts can create a lobby, players can join with a PIN and nickname, select a quiz, and run through a short quiz while players answer in real time.

This repository contains a .NET backend and a Next.js frontend.

Features

  • Host creates a lobby and shares a 6-digit PIN with players
  • Players join a lobby using PIN + nickname
  • Host selects one of several quizzes
  • Real-time gameplay using SignalR: questions, timers, answers
  • 4 options per question, 20s timer per question
  • Score tracking and final results shown to all players

Quickstart (development)

Prerequisites

  • Node.js 18+
  • .NET SDK 8+
  1. Clone the repository
git clone https://github.com/docVoid/OpenLiQ.git
cd OpenLiQ
  1. Backend (API + SignalR hub)
cd backend/OpenLiQ.Api
dotnet restore
dotnet run

The backend runs the SignalR hub at http://localhost:5000.

  1. Frontend (Next.js)
cd frontend
npm install
npm run dev

Open http://localhost:3000 in your browser. Create a lobby as Host, share the PIN with players, let them join via /player/join, pick a quiz and start.

Project structure

  • backend/OpenLiQ.Api - .NET Web API + SignalR hub + in-memory game state service
  • frontend - Next.js app with Host and Player views and SignalR client
  • docs - assets and documentation

Configuration

  • Frontend uses NEXT_PUBLIC_API_URL to point to the backend SignalR hub, defaults to http://localhost:5000.
  • Backend config in appsettings.json and appsettings.Development.json.

License & Attribution

This project is licensed under the MIT License. See the LICENSE

Attribution: OpenLiQ — (c) docVoid

Contributing

Contributions welcome — open issues or PRs.

About

Real-time Quiz Game Platform.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published