Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Dependencies
node_modules/
.npm/
/package-lock.json

# Build output
dist/
build/
.next/
.vite/

# Environment files
.env
.env.local
.env.*.local

# Legacy database (sensitive data - NEVER upload)
legacydb/

# OS files
.DS_Store
Thumbs.db

# IDE
.idea/
.vscode/
*.swp
*.swo
*~

# Logs
logs/
*.log
npm-debug.log*

# Coverage
coverage/
client/test-results/

# Docker volumes
mongo-data/
data/db/
.data/

# Temporary files
tmp/
.tmp/
.qlicker.pids

# Uploaded files
server/uploads/

# Production setup runtime data (sensitive/generated — NEVER commit)
production_setup/.env
production_setup/certs/
production_setup/backups/
production_setup/legacydb/

# Load testing generated state (contains credentials) and results
load-testing/state.json
load-testing/state/
load-testing/results/
load-testing/node_modules/
load-testing/.env
46 changes: 44 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,44 @@
# qlicker2
In class polling, onlines quizzes, practice question, grade manage, question libraries, and SSO integration.
# Qlicker

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a much better readme


Qlicker is a classroom response system (clicker) for higher education. It allows professors to create interactive sessions with questions (multiple choice, true/false, short answer, multi-select, numerical) that students can answer in real-time, as well as timed quizzes. It includes grading, group management, video chat features, question libraries, and SSO integration.

This repository is the new home for Qlicker, migrated from the original [MeteorJS implementation](https://github.com/qlicker/qlicker) to a modern **Fastify + React** stack. The code is being moved from [ryanmartinneutrino/qlicker-1](https://github.com/ryanmartinneutrino/qlicker-1).

## Repository Structure

Once the migration code is brought in, the repository will be structured as follows:

```
├── server/ # Fastify backend
├── client/ # React frontend (Vite)
├── ssoserver/ # Isolated local SimpleSAMLphp IdP for SSO smoke tests
├── load-testing/ # k6 load testing scenario + seed script
├── production_setup/ # Self-contained production deployment package
├── scripts/ # Setup and utility scripts
├── docs/ # Developer and user documentation
├── docker-compose.yml # Docker orchestration (development)
└── .env.example # Environment variable template
```

## Tech Stack

- **Backend:** [Fastify](https://fastify.dev/) (Node.js)
- **Frontend:** [React](https://react.dev/) + [Vite](https://vitejs.dev/)
- **Database:** MongoDB
- **Cache / Pub-Sub:** Redis (optional; enables multi-instance WebSocket pub/sub)
- **Auth:** Session-based with optional SAML SSO

## Prerequisites

- Node.js >= 20.x
- npm >= 10.x
- MongoDB >= 6.x (or Docker)
- Redis >= 7.x (optional — or Docker)

## Status

> **Note:** The application code is being migrated into this repository. See [ryanmartinneutrino/qlicker-1](https://github.com/ryanmartinneutrino/qlicker-1) for the current working implementation.

## License

This project is licensed under the [GNU General Public License v3.0](LICENSE).