Skip to content

Frontend repository for an Online Treasure Hunt application, with clues to Locations of IIT Kharagpur, and answers to be guessed by clicking on the custom map

License

Notifications You must be signed in to change notification settings

TejasAmbhore/react_vct

Repository files navigation

Contributors Issues MIT License


TAdS VCT 2.0

Table of Contents

  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

Snapshots of Approach



Inspiration

Every year Technology Adventure Society, IIT Kharagpur organises a Cycle Trip for the Freshers to get familiar with different places in the campus. To make sure that you guys don't miss on the experience in online semester, we have organised a Virtual Cycle Trip in the form of a Treasure Hunt to give you a virtual magical tour of the campus and win some exciting prizes along the way.

How We built it

We built the front-end using ReactJS with the help of Minimal-UI. The back-end was built in NodeJS, ExpressJS with MongoDB as database. We deployed the front-end using AWS Amplifyapp, used AWS Elastic BeanStalk for hosting the back-end server and created a HTTPS Proxy using AWS API Gateway.

Accomplishments that we're proud of

We were able to deploy the web app and test it successfully. Engaged more than 800 fresher participants and the servers handled the traffic really well.

Features:

  • Easy to interact UI
  • Personal Harry Potter themed profile
  • Clues linked to locations on the map

Built With

  • ReactJS
  • NodeJS
  • ExpressJS
  • MongoDB
  • AWS

Getting Started

Prerequisites

  • Install the dependencies which are related to NodeJS, MongoDB

Local Setup

  • If you wish to run your own build, first ensure you have nodejs installed in your computer. If not, you can get nodejs here.

  • Clone the repository

    • Using HTTPS

      git clone https://github.com/tejasambhore/react_vct
    • Using SSH

      git clone [email protected]:tejasambhore/react_vct.git
  • Download all the dependencies

    npm install

For running npm server

  • Run server

    npm run start

Roadmap

  • [✅] Create front-end
  • [✅] Create back-end and integrate it with front-end
  • [✅] Deploy the mern application

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contributors

Thanks to all the people who contribute

Contributors

Acknowledgments

About

Frontend repository for an Online Treasure Hunt application, with clues to Locations of IIT Kharagpur, and answers to be guessed by clicking on the custom map

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published