-
Notifications
You must be signed in to change notification settings - Fork 1
Initialize qlicker2 repository for migration from MeteorJS #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
Copilot
wants to merge
2
commits into
master
Choose a base branch
from
copilot/migrate-qlicker-app-code
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
|
|
||
| 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). | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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