Skip to content

tsg-iitkgp/web-frontend

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

TSG Site Frontend

Report Bug · Request Feature

Table of Contents

Development

Libraries/Frameworks Used

This project has been built with the following technologies.

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] +91-9761667733
Parth Gupta [email protected] +91-7620821543

(back to top)

Acknowledgements

(back to top)

Additional Documentation

(back to top)