TSG Site Frontend

Report Bug · Request Feature

Table of Contents

• Development
  • Setting Up Locally
• Project Structure
  • File Structure
  • Libraries/Frameworks Used
• Roadmap
• Contributing
• Contact
• Acknowledgements

(back to top)

Development

Setting Up Locally

• 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.

(back to top)

Project Structure

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.

Libraries/Frameworks Used

This project has been built with the following technologies.

• React
• Bootstrap
• React Router

(back to top)

Roadmap

See the open issues for a list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

For any ideas, suggestions or queries, please mail us at [email protected]

Present Technology Coordinator(s)

Name: Arpit Bhardwaj
Email: [email protected]
Phone: +91-9761667733

Name: Parth Gupta
Email: [email protected]
Phone: +91-7620821543

(back to top)

Acknowledgements

• Img Shields
• GitHub Pages

(back to top)