tsg-iitkgp / web-frontend

Gymkhana website Frontend

TSG Site Frontend

Report Bug · Request Feature

Table of Contents

• Development
  • Libraries/Frameworks Used
  • File Structure
  • Setting Up Locally
    • Bare metal
    • Docker
• Contact
• Acknowledgements
• Additional Documentation

Development

Libraries/Frameworks Used

This project has been built with the following technologies.

• React
• Bootstrap
• React Router

File Structure

.
├── public
└── src
   ├── components
   ├── data
   ├── images
   ├── pages
   ├── routes
   ├── styles
   └── App.js

• public: Contains public files such as index.html.
• src: Contains source files (JS, CSS, assets, etc.)
  • components: Contains reusable react components.
  • data: Contains raw data.
  • images: Contains images and icons.
  • pages: Contains all pages.
  • routes: Contains custom routes.
  • styles: Contains all stylesheets (CSS).
  • utils: Contains commonly used util functions.
  • App.js: Contains the top-level App component.

Setting Up Locally

It is prefferred to use docker over bare metal setup.

Docker

• Install docker and docker-compose. For ubuntu, follow the comamnds below:

  sudo apt install docker.io docker-compose

• Start the container using docker-compose.yml file

  sudo docker-compose up -d

• The site will be hosted at http://localhost:8000

Bare Metal

• Install NodeJS
• Install or enable Yarn
• Clone this repository
• Run yarn install in the cloned repository to download all dependencies
• Run yarn start to start a local development server
• The site will be hosted at http://localhost:3000

(back to top)

Contact

Note

For any ideas, suggestions or queries regarding the website, mail us at [email protected]

Present Technology Coordinator(s)

Name	Email	Phone No.
Arpit Bhardwaj	[email protected]	[phone]
Parth Gupta	[email protected]	[phone]

(back to top)

Acknowledgements

• Img Shields
• GitHub Pages

(back to top)

Additional Documentation

• Changelogs
• License
• Security Policy
• Code of Conduct
• Contribution Guidelines

(back to top)

web-frontend's Issues

Data Update (July 2022)

TODO

• gather and add Inter IIT Tech Meet data to results/inter_iit (2019 and onwards)
• create results/inter_hall for Inter Hall results display
• gather and add Inter Hall results data (starting with 2021-2022)

Add Google Analytics

TODO

Login to tech.tsgiitkgp google analytics account and add the analytics of the project which was created earlier for the old website

Improve the file structure

TODO

• Organise the scattered JavaScript and CSS files.
• Add comments wherever necessary.
• Make the code modular.

Create committee pages for 22-23

TODO

Create new version of committee pages for the academic session 22-23

Make contact-us page functional

• This issue is in sync with #6 on tsg-iitkgp/tsg-backend.
• Send a POST request onto the backend endpoint when someone submits the data.

Performance of Bar Chart

TODO

• Read the documentation of the Bar Chart implemented on the Results page.
• Improve the performance of the Chart.

Improve CSS of committee pages

TODO

• Create a common/global CSS for committee pages
• Add a module CSS for each of the committees
• Make committee pages responsive

Update the README.md

TODO

• Update the README with all the relevant details of the project