{"id":30207656,"url":"https://github.com/3bbaas/quizme-cli","last_synced_at":"2026-06-17T23:31:26.594Z","repository":{"id":298353528,"uuid":"999700354","full_name":"3bbaas/QuizMe-cli","owner":"3bbaas","description":"QuizMe is an interactive command-line quiz tool that transforms JSON-based question banks into engaging quizzes. Perfect for students, or anyone who wants to test their knowledge in a fun and interactive way.","archived":false,"fork":false,"pushed_at":"2025-06-10T17:25:20.000Z","size":50,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-13T16:28:27.685Z","etag":null,"topics":["cli","node-js"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@3bbas/quizme","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/3bbaas.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-10T16:46:42.000Z","updated_at":"2025-07-04T18:00:41.000Z","dependencies_parsed_at":"2025-06-10T18:37:05.265Z","dependency_job_id":"8129cc78-77cb-45f8-a31d-f53d6533beef","html_url":"https://github.com/3bbaas/QuizMe-cli","commit_stats":null,"previous_names":["3bbaas/quizme-cli"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/3bbaas/QuizMe-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3bbaas%2FQuizMe-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3bbaas%2FQuizMe-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3bbaas%2FQuizMe-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3bbaas%2FQuizMe-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/3bbaas","download_url":"https://codeload.github.com/3bbaas/QuizMe-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3bbaas%2FQuizMe-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34470322,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-17T02:00:05.408Z","response_time":127,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","node-js"],"created_at":"2025-08-13T16:13:23.328Z","updated_at":"2026-06-17T23:31:26.589Z","avatar_url":"https://github.com/3bbaas.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# QuizMe - Interactive CLI Quiz Tool\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/3bbaas/quizme/blob/main/assets/demo.png\" alt=\"QuizMe demo\" width=\"400\" /\u003e\n\u003c/div\u003e\n\n[![NPM Version](https://img.shields.io/npm/v/@3bbas/quizme.svg)](https://www.npmjs.com/package/@3bbas/quizme)\n[![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](https://opensource.org/licenses/ISC)\n\nQuizMe is an interactive command-line quiz tool that transforms JSON-based question banks into engaging quizzes. Perfect for students, or anyone who wants to test their knowledge in a fun and interactive way.\n\n## Features\n\n- **Interactive CLI Interface**: Colorful and engaging command-line interface\n- **Multiple Question Sources**: Load questions from local files or remote URLs\n- **LaTeX Support**: Automatic conversion of LaTeX math formulas to Unicode\n- **True/False and Multiple-Choice**: Support for different question formats\n- **Randomized Questions**: Questions are shuffled for a fresh experience every time\n- **Timed Quizzes**: Track how long it takes to complete each quiz\n- **Results Summary**: Review your performance with detailed statistics\n- **Error Handling**: Robust validation for file paths and URLs\n\n## Installation\n\n```bash\n# Install globally\nnpm install -g @3bbas/quizme\n\n# Or use npx\nnpx @3bbas/quizme\n```\n\n## Usage\n\n### Basic Usage\n\nRun the command to start the quiz:\n\n```bash\nquizme\n```\n\n### JSON Format\n\nYour quiz JSON file should follow this format:\n\n```json\n[\n  {\n    \"id\": 1,\n    \"question\": \"What is the capital of France?\",\n    \"options\": {\n      \"A\": \"London\",\n      \"B\": \"Paris\",\n      \"C\": \"Berlin\",\n      \"D\": \"Madrid\"\n    },\n    \"answer\": \"B\"\n  },\n  {\n    \"id\": 2,\n    \"question\": \"The speed of light in a vacuum is about $30 \\\\, \\\\text{cm/ns}$.\",\n    \"answer\": true,\n    \"id\": 2\n  }\n]\n```\n\nThe tool supports:\n- **Multiple-choice questions**: With `options` object and an `answer` that matches one of the option keys\n- **True/False questions**: With a boolean `answer` property\n- **LaTeX formatting**: For math formulas that are automatically converted to Unicode\n\n## Features in Detail\n\n### 1. Quiz Sources\n\nQuizMe supports loading quiz questions from:\n\n- **Local JSON files**: Specify a path to a JSON file on your system\n- **Remote URLs**: Provide a URL to a JSON endpoint (e.g., `https://example.com/quiz.json`)\n\n### 2. LaTeX to Unicode Conversion\n\nThe tool automatically converts LaTeX math notation to Unicode characters:\n\n- Fractions: `\\frac{1}{2}` → `1/2`\n- Square roots: `\\sqrt{2}` → `√2`\n- Greek letters: `\\alpha`, `\\beta`, etc. → `α`, `β`, etc.\n- Mathematical symbols: `\\infty`, `\\pm`, etc. → `∞`, `±`, etc.\n\n### 3. Question Processing\n\n- **Shuffling**: Questions are randomly shuffled for each quiz attempt\n- **Validation**: Questions are validated for required fields\n- **Format handling**: Both multiple-choice and True/False questions are supported\n- **Default options**: Questions with missing options are provided with defaults\n\n### 4. User Interface\n\n- **Interactive prompts**: Easy selection of options using arrow keys\n- **Color coding**: Questions, answers, and results are displayed with intuitive colors\n- **Loading spinners**: Visual feedback during data loading and processing\n- **Readable output**: Clear presentation of questions and results\n\n### 5. Quiz Flow\n\n1. **Source selection**: Choose between local file or remote URL\n2. **Question loading**: Load and process questions\n3. **Quiz progression**: Answer questions one by one\n4. **Feedback**: Immediate feedback after each answer\n5. **Results**: Detailed summary of performance at the end\n\n### 6. Timing and Results\n\n- **Timer**: Tracks the total time taken to complete the quiz\n- **Score calculation**: Tallies correct and incorrect answers\n- **Incorrect answers review**: Option to review all incorrect answers at the end\n\n## File Structure\n\n- **cli.ts**: Main entry point and command-line interface\n- **fileLoader.ts**: Handles loading quiz data from files or URLs\n- **quizRunner.ts**: Manages the quiz flow and user interaction\n- **timer.ts**: Tracks quiz duration\n- **types.ts**: TypeScript interfaces for quiz data\n- **utils.ts**: Utility functions for LaTeX conversion and validation\n\n\u003c!-- ## Development\n\nClone the repository and install dependencies:\n\n```bash\ngit clone https://github.com/3bbas/quizme.git\ncd quizme\nnpm install\n```\n\nBuild the project:\n\n```bash\nnpm run build\n```\n\nTest the tool locally:\n\n```bash\nnode dist/cli.js\n```\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThis project is licensed under the ISC License - see the [LICENSE](LICENSE) file for details.\n --\u003e\n## Author\n\nCreated by [3bbas](https://github.com/3bbaas)\n\n---\n\nEnjoy testing your knowledge with QuizMe! 🎓","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3bbaas%2Fquizme-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F3bbaas%2Fquizme-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3bbaas%2Fquizme-cli/lists"}