The above codebase is for the official gymkhana website of Indian Institute of Technology, (IIT) Dharwad. The website is responsible for displaying all the student based activities that happen at the institute.
The website currently is a static website built on React and Typescript. React Bootstrap has been heavily used for styling and Flux application architecture has been replicated for the website.
The following is the folder structure used while developing the application
├── assets # JSON and static files like images which hold the static information present on the website
├── components # Components and modules on the site which can be reused or help making code leaner.
├── model # Interfaces and other model structures that are used for type safety in the codebase.
├── pages # Parent level components which are used in the single page website
├── routes # Routes available on the website. Made while keeping the scalability in mind.
├── styles # Global styles which are to be used across all the components.
└── template # Wrapper components applied on native components to add functionality or styling
IIT Dharwad Gymkhana welcomes contributions. While contributing, please follow the guidelines listed below:
Feel free to submit issues and enhancement requests.
The issues and enhancement can range from visible responsive bugs to new features that could have been included in the website so it could serve its purpose better. The maintainers will look into them and if they are upto the mark, shall work to have them updated.
Please refer to each project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull request so that we can review your changes
NOTE: Be sure to merge the latest from "upstream" before making a pull request!