MFC-VIT / SOTY-Backend-24

Official repository for backend of SOTY 2024

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MozillaFirefox-VIT


Scavanger Of The Year Backend '24

The official Backend API for Scavanger Of The Year'24 Event Portal

Event Details

"Scavanger Of The Year" (SOTY), a treasure hunt event website where participants engage through the site.

Tech Stack

  • Node.js
  • Express.js
  • MongoDB

Features

  • User Authentication
  • Single user Login
  • Users gets Question from each category of difficulty level(Easy, Medium, Hard)
  • Users cannot move to next question until currect question is answered
  • Scan correct qr to get points and next question
  • Two consecutive incorrect answers blocks the user for the next 2 mins from scanning qrs and answering
  • Seeders for seeding questions to the DB( All users will get question present in seederQuestion.js)
  • Admins can directly change teams scores
  • Admins can Ban users for next 15 mins
  • Admins can UnBan user immediately

Steps To Run

  1. Clone the Repository:

    git clone https://github.com/MFC-VIT/SOTY-Backend-24.git

  2. Install all the dependencies:

    npm i

  3. Update the .env file with our configs.

  4. Update the questions.json file with the questions, answers, points, difficultyLevel, answered as pending.

  5. Update the seederQuestions.json file with the questions, points, difficultyLevel, answered as false.

  6. To Start the server:

    npm start

  7. To seed questions to DB:

    cd seeders && node seedQuestions.js

  8. Use postman and test the api at the endpoints

Authors

Harsit

Harshit P G

GitHub LinkedIn

License

Copyright © 2024, MozillaFirefox-VIT, Harshit P G and all other contributors. Released under the MIT License.

Made with ❤️ by MFC-VIT

About

Official repository for backend of SOTY 2024

License:MIT License


Languages

Language:JavaScript 100.0%