{"id":17712583,"url":"https://github.com/osandadeshan/markdown-quiz-app","last_synced_at":"2026-04-08T16:32:32.818Z","repository":{"id":258456406,"uuid":"873957254","full_name":"osandadeshan/markdown-quiz-app","owner":"osandadeshan","description":"A simple, lightweight quiz application built with Node.js that allows candidates to take quizzes based on a markdown file of questions and answers.","archived":false,"fork":false,"pushed_at":"2024-10-21T08:32:08.000Z","size":84,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-21T11:03:40.050Z","etag":null,"topics":["css","express","expressjs","html","markdown","nodejs","quiz","quiz-app"],"latest_commit_sha":null,"homepage":"https://markdown-quiz-app.onrender.com","language":"JavaScript","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/osandadeshan.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}},"created_at":"2024-10-17T02:27:31.000Z","updated_at":"2024-10-21T08:32:12.000Z","dependencies_parsed_at":"2024-10-21T10:48:38.822Z","dependency_job_id":null,"html_url":"https://github.com/osandadeshan/markdown-quiz-app","commit_stats":null,"previous_names":["osandadeshan/markdown-quiz-app"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/osandadeshan/markdown-quiz-app","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osandadeshan%2Fmarkdown-quiz-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osandadeshan%2Fmarkdown-quiz-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osandadeshan%2Fmarkdown-quiz-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osandadeshan%2Fmarkdown-quiz-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/osandadeshan","download_url":"https://codeload.github.com/osandadeshan/markdown-quiz-app/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osandadeshan%2Fmarkdown-quiz-app/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31564900,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"ssl_error","status_checked_at":"2026-04-08T14:31:17.202Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["css","express","expressjs","html","markdown","nodejs","quiz","quiz-app"],"created_at":"2024-10-25T09:05:38.159Z","updated_at":"2026-04-08T16:32:32.794Z","avatar_url":"https://github.com/osandadeshan.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Markdown Quiz Application\n\nA simple, lightweight quiz application built with Node.js that allows candidates to take quizzes based on a markdown file of questions and answers. The application supports multiple-choice (radio buttons), multiple-answer (checkboxes), and text input (case-insensitive) question formats. It also provides user login, quiz results, and answer review functionality.\n\n---\n\n# Table of Contents\n\n- [Key Features](#key-features)\n- [Advantages](#advantages)\n- [Tools and Technologies](#tools-and-technologies)\n- [How to Use the Application](#how-to-use-the-application)\n  - [1. Clone the Repository](#1-clone-the-repository)\n  - [2. Install Dependencies](#2-install-dependencies)\n  - [3. Set Up the Application](#3-set-up-the-application)\n  - [4. Run the Application](#4-run-the-application)\n  - [5. Access the Application](#5-access-the-application)\n- [Sample Application](#sample-application)\n- [Project Structure](#project-structure)\n- [Future Enhancements](#future-enhancements)\n- [Contributions](#contributions)\n- [License](#license)\n- [Contact](#contact)\n- [Acknowledgments](#acknowledgments)\n\n---\n\n## Key Features\n\n- **Multiple Question Types**: Supports single answer (radio buttons), multiple answer (checkboxes), and text input questions.\n- **User Authentication**: Simple login functionality to allow candidates to access quizzes.\n- **Quiz Progress \u0026 Results**: Displays quiz score upon completion with correct/incorrect answer feedback.\n- **Markdown Support**: Quiz questions are read from a markdown file, making quiz creation easy and scalable.\n- **Results Persistence**: Users can review their previous scores after completing the quiz.\n\n---\n\n## Advantages\n\n1. **Flexibility**: The markdown-driven quiz setup allows easy modification of questions and answers without changing the code.\n2. **User-Friendly**: Intuitive interface for candidates to take quizzes, login, and view results.\n3. **Scalable**: The markdown structure ensures scalability for quizzes with different question types.\n4. **Customizable**: You can easily modify the types of questions, add new question types, or integrate additional functionality.\n5. **Easy Hosting**: Front-end can be deployed on GitHub Pages, while the back-end can be hosted on platforms like Heroku or Render for free.\n\n---\n\n## Tools and Technologies\n\n- **Node.js**: JavaScript runtime used to build the backend logic of the application.\n- **Express.js**: Web framework for handling routes and HTTP requests.\n- **Sessions \u0026 Cookies**: Used for maintaining user sessions and ensuring quiz state.\n- **Markdown**: Simplifies quiz creation and management by storing questions in a plain text file.\n- **Bootstrap**: Provides styling and responsive design for the UI.\n- **Render**: For deploying the back-end (Node.js server).\n\n---\n\n## How to Use the Application\n\n### 1. Clone the Repository\n\nTo get started, clone the repository to your local machine:\n\n```bash\ngit clone https://github.com/osandadeshan/markdown-quiz-app.git\ncd markdown-quiz-app\n```\n\n### 2. Install Dependencies\n\nMake sure you have Node.js installed, then install the required dependencies by running:\n\n```bash\nnpm install\n```\n\n### 3. Set Up the Application\n\nEnsure you have a .env file in the root directory of the project for environment variables such as:\n\n```bash\nSESSION_SECRET=your_random_secret_key\n```\n\nUpdate the markdown file with your quiz content in the questions.md file.\n\n### 4. Run the Application\n\nTo run the application in production mode, run:\n\n```bash\nnpm start\n```\n\nTo run the application in development mode using Nodemon, run:\n\n```bash\nnpm run dev\n```\n\n### 5. Access the Application\n\nVisit http://localhost:3000 in your browser to interact with the quiz application.\n\n---\n\n## Sample Application\n\nA sample version of the application is deployed on [Render](https://dashboard.render.com/). You can try it out [here](https://markdown-quiz-app.onrender.com).\n\n---\n\n## Project Structure\n\n```bash\n├── node_modules        # Dependencies installed via npm\n├── public              # Static files like HTML, CSS\n│   ├── views\n│   │   ├── login.html  # Login page\n│   │   ├── styles.css  # CSS for styling\n├── quizzes             # Markdown files containing quizzes\n│   ├── quiz.md         # Example quiz markdown file\n│   ├── maxsoft.md      # Another quiz file\n├── .env                # Environment variables (session secret, etc.)\n├── app.js              # Main application logic\n├── package-lock.json   # Dependency lock file\n├── package.json        # Project configuration and scripts\n├── README.md           # Project documentation\n└── users.json          # Users' login credentials\n```\n\n---\n\n## Future Enhancements\n\n- **Enhanced Authentication**: Enhance the security of the login mechanism for candidates by allowing them to log in using their registered email addresses from our `users.json` file.\n- **Add Timer Feature**: Implement a quiz timer for competitive scenarios.\n- **Add Admin Dashboard**: Enable admin users to upload new markdown quiz files through a UI.\n- **Improve Results Page**: Show more statistics such as time taken and comparison with other users.\n\n---\n\n## Contributions\n\nWe welcome contributions to this project! To contribute:\n\n1. Fork the repository.\n2. Create a new branch (`git checkout -b feature-branch`).\n3. Commit your changes (`git commit -m 'Add feature'`).\n4. Push to the branch (`git push origin feature-branch`).\n5. Create a pull request.\n\n---\n\n## License\n\nThis project is licensed under the MIT License. You are free to use, modify, and distribute this software under the terms of the license.\n\n\u003cimg src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/0/0b/License_icon-mit-2.svg/2000px-License_icon-mit-2.svg.png\" alt=\"MIT License\" width=\"100\" height=\"100\"/\u003e [MIT License](https://opensource.org/licenses/MIT)\n\n---\n\n## Contact\n\nFor any inquiries or issues, feel free to open an issue on the repository or contact me at:\n\n- **Email**: your.osanda.deshan@gmail.com\n- **LinkedIn**: [Osanda Deshan](https://www.linkedin.com/in/osandadeshan/)\n\n---\n\n## Acknowledgments\n\nThanks to Node.js, Express.js, Bootstrap, and the open-source community for making this project possible.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosandadeshan%2Fmarkdown-quiz-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fosandadeshan%2Fmarkdown-quiz-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosandadeshan%2Fmarkdown-quiz-app/lists"}