{"id":23921296,"url":"https://github.com/opencodeiiita/grepit-backend","last_synced_at":"2025-09-11T05:31:13.630Z","repository":{"id":212346460,"uuid":"723129590","full_name":"opencodeiiita/GrepIt-Backend","owner":"opencodeiiita","description":"Quiz-hosting application to create quizzes, extensively utilising websockets.","archived":true,"fork":false,"pushed_at":"2024-01-12T15:25:40.000Z","size":250,"stargazers_count":8,"open_issues_count":1,"forks_count":15,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-13T07:43:53.505Z","etag":null,"topics":["express","nodejs","opencode23","websocket"],"latest_commit_sha":null,"homepage":"https://grep-it-api.onrender.com/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/opencodeiiita.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-11-24T19:06:16.000Z","updated_at":"2024-12-08T13:16:06.000Z","dependencies_parsed_at":"2024-01-12T18:07:44.800Z","dependency_job_id":null,"html_url":"https://github.com/opencodeiiita/GrepIt-Backend","commit_stats":null,"previous_names":["opencodeiiita/grepit-backend"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/opencodeiiita/GrepIt-Backend","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencodeiiita%2FGrepIt-Backend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencodeiiita%2FGrepIt-Backend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencodeiiita%2FGrepIt-Backend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencodeiiita%2FGrepIt-Backend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opencodeiiita","download_url":"https://codeload.github.com/opencodeiiita/GrepIt-Backend/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencodeiiita%2FGrepIt-Backend/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274583053,"owners_count":25311731,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-11T02:00:13.660Z","response_time":74,"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":["express","nodejs","opencode23","websocket"],"created_at":"2025-01-05T16:14:41.874Z","updated_at":"2025-09-11T05:31:13.348Z","avatar_url":"https://github.com/opencodeiiita.png","language":"JavaScript","readme":"# GrepIt-Backend\n\nA quiz-hosting application, where a user can create a quiz-room, allowing multiple others to join the room. The questions can be set manually for that room, and the one with the most right answers win the top-spot on the leaderboard!\n\n## 📚 Table Of Contents\n\n-   [How It Works](#🚀-how-it-works)\n-   [Features](#🌐-features)\n-   [Tech Stack](#⚡-tech-stack)\n-   [Dependencies](#📦-dependencies)\n-   [How To Setup](#🛠️-how-to-setup)\n-   [Reference Links](#🔗-reference-links)\n-   [Directory Structure](#📁-directory-structure)\n-   [Claim an Issue](#👆-claim-an-issue)\n-   [Communication](#💻-communication)\n-   [License](#🛡️-license)\n-   [Contribution Guidelines](#📋-contribution-guidelines)\n-   [Mentors](#🤝-Mentors)\n\n## 🚀 How It Works:-\n\n-   The creator has the option to create multiple MCQ type questions.\n-   Other users can join the room entering the code.\n-   Once the creator starts the quiz, each question will be displayed one-by-one, each having a timer and points awarded based on how fast one answers.\n-   At the end of the quiz, you will be able to view a leaderboard. The creator can now restart the quiz (having the option to reset the questions).\n-   Features can be implemented to archive the room and the leaderboard.\n\n## ⚡ Tech Stack:\n\n-   Nodejs (v20.5.0)\n-   ExpressJS\n-   MySQL\n\n## 📦 Dependencies:\n\nYou need npm/yarn installed in your local machine in order to run this app.\n\n## 🛠️ How To Setup\n\n-   Make sure your machine is having internet connection.\n-   Fork the repository.\n-   Open shell (which ever your OS support) on your PC.\n-   Change drive to the location where you want your project to be copied.\n-   Clone it to your local setup by using command `git clone \u003cforked-repo-link\u003e`.\n-   Once cloned, Run the following command in the root directory of the project `npm install`.\n-   Make sure you have required enviornment variables saved in the `.env` file in the root of the project. A file `.env.example` is attached for reference.\n-   After the process is completed, run the command `npm start` or `npm run dev`.\n-   The backend will be live on `localhost:4000`.\n\n```bash\n  npm install\n  npm start\n```\n\n## Reference Links:\n\n-   [Download and install the latest version of Git.](https://git-scm.com/downloads)\n-   [Set your username in Git.](https://help.github.com/articles/setting-your-username-in-git)\n-   [Set your commit email address in Git.](https://help.github.com/articles/setting-your-commit-email-address-in-git)\n-   [Setup Nodejs](https://nodejs.org/en/blog/release/v16.18.1/)\n\n### 🖥️ Express.js\n\n-   [Express Crash Course](https://www.youtube.com/watch?v=L72fhGm1tfE\u0026ab_channel=TraversyMedia)\n-   [Mastering Node.js](https://www.youtube.com/playlist?list=PLinedj3B30sDby4Al-i13hQJGQoRQDfPo)\n\n### 🗃️ MySQL with Prisma ORM\n\n-   [Get Started](https://www.prisma.io/docs/getting-started/setup-prisma/start-from-scratch/relational-databases/connect-your-database-node-mysql)\n-   [MySQL in prisma](https://www.prisma.io/docs/orm/overview/databases/mysql)\n-   [YT Crash Course](https://www.youtube.com/watch?v=RebA5J-rlwg\u0026pp=ygUad2ViIGRldiBzaW1wbGlmaWVkIHByaXNtYSA%3D)\n\n### API Documentation\n\nKindly refer to this file [API_ENDPOINTS](API_ENDPOINTS.md) for easier understanding.\nUpdate the `API_ENDPOINTS.md` file as you write/complete a controller function.\n\n## 📁 Directory Structure:\n\n```bash\n.\n├── API_ENDPOINTS.md\n├── app.js\n├── CONTRIBUTORS.md\n├── LICENSE\n├── package.json\n├── package-lock.json\n├── prisma\n│   └── schema.prisma\n├── README.md\n└── src\n    ├── config\n    │   └── db.config.js\n    ├── controllers\n    │   ├── questions.controllers.js\n    │   ├── room.controllers.js\n    │   └── userAuth.controllers.js\n    ├── middlewares\n    │   └── userAuth.middleware.js\n    ├── routes\n    │   ├── index.routes.js\n    │   └── v1\n    │       ├── questions.routes.js\n    │       ├── room.routes.js\n    │       ├── userAuth.routes.js\n    │       └── v1-main.js\n    └── utils\n        └── responseCodes.js\n\n8 directories, 19 files\n\n```\n\n\u003e [!NOTE]\n\u003e While adding new files make sure to have an entry here. It will be helpful to new contributors.\n\n## 👆 Claim an issue:\n\nComment on the issue. In case of no activity on the issue even after 2 days, the issue will be reassigned. If you have difficulty approaching the issue, feel free to ask on our discord channel.\n\n-   It is also requested to make your entry in [CONTRIBUTORS](CONTRIBUTORS.md) markdown file before submitting the PR.\n\n## 💻 Communication:\n\nWhether you are working on a new feature or facing a doubt please feel free to ask us on our [discord](https://discord.gg/D9999YTkS8) channel. We will be happy to help you out.\n\n## 🛡️ License\n\nThis project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.\n\n## 📋 Contribution Guidelines:\n\nPlease help us follow the best practice to make it easy for the reviewer as well as the contributor. We want to focus on the code quality more than on managing pull request ethics.\n\n-   People before code: If any of the following rules are violated, the pull-requests will be rejected. This is to create an easy and joyful onboarding process for new programmers and first-time contributors.\n\n-   Avoid commiting after opening pull request and name the commit as something meaningful, it is highly recommened to follow.\n\n-   Reference the issue numbers in the commit message if it resolves an open issue. Follow the pattern provided [here](.github/PULL_REQUEST_TEMPLATE.md).\n\n-   Provide relevant screenshot/short video for easier review.\n\n-   Pull Request older than 3 days with no response from the contributor shall be marked closed.\n\n-   Avoid duplicate PRs, if need please comment on the older PR with the PR number of the follow-up (new PR) and close the obsolete PR yourself.\n\n-   Be polite: Be polite to other community members.\n\n## 🤝 Mentors\n\n1.  **Bhupesh Dewangan**  \n    _Opencode Bot Developer_  \n    _The YT demonstrator guy ;-;_  \n    `githubID:` [bhupesh98](https://github.com/bhupesh98)  \n    `discordID:` bhupesh6726 (aka Bhupesh)\n\n2.  **Vatsal Bhuva**  \n    _Opencode Portal Developer_  \n    _Most active mod on Discord (ig?)_\u003cbr/\u003e\n    `githubID:` [VatsalBhuva11](https://github.com/VatsalBhuva11)  \n    `discordID:` vb11x (aka vatsal)\n\n## 💪 Thanks To All Contributors\n\nAll the contributor's github profile image will be displayed here, pick up the best one real quick.\n\n\u003cdiv align=\"left\"\u003e\n    \u003c!-- FORMAT TO ADD YOUR ENTRY\n    \u003ca href=\"https://github.com/\u003cGITHUB_USERNAME\u003e\" title=\"\u003cGITHUB_USERNAME\u003e\"\u003e\n        \u003cimg src=\"https://github.com/\u003cGITHUB_USERNAME\u003e.png\" width=\"70px\" style=\"border-radius: 50%\" alt=\"\u003cFULL_NAME\u003e\"\u003e\n    \u003c/a\u003e\n    replace \u003cGITHUB_USERNAME\u003e with your GitHub username\n    replace \u003cFULL_NAME\u003e with your full name\n    --\u003e\n    \u003ca href=\"https://github.com/VatsalBhuva11\" title=\"VatsalBhuva11\"\u003e\n        \u003cimg src=\"https://github.com/VatsalBhuva11.png\" width=\"70px\" alt=\"Vatsal Bhuva\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/bhupesh98\" title=\"bhupesh98\"\u003e\n        \u003cimg src=\"https://github.com/bhupesh98.png\" width=\"70px\" alt=\"Bhupesh Dewangan\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/criticic\" title=\"Sagnik Mandal\"\u003e\n        \u003cimg src=\"https://github.com/criticic.png\" width=\"70px\" alt=\"Sagnik Mandal\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/Apoorv012\" title=\"Apoorv Mittal\"\u003e\n        \u003cimg src=\"https://github.com/Apoorv012.png\" width=\"70px\" alt=\"Apoorv Mittal\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/WadadParker\" title=\"Wadad Parker\"\u003e\n        \u003cimg src=\"https://github.com/WadadParker.png\" width=\"70px\" alt=\"Wadad Parker\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/DikshantK2004\" title=\"Dikshant Khandelwal\"\u003e\n        \u003cimg src=\"https://github.com/DikshantK2004.png\" width=\"70px\" alt=\"Dikshant Khandelwal\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/Jarviss77\" title=\"Shubham Gupta\"\u003e\n        \u003cimg src=\"https://github.com/Jarviss77.png\" width=\"70px\" alt=\"Shubham Gupta\"\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopencodeiiita%2Fgrepit-backend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopencodeiiita%2Fgrepit-backend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopencodeiiita%2Fgrepit-backend/lists"}