diff --git a/README.md b/README.md index ff437c5a..e660db16 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,6 @@ [![MIT License][license-shield]][license-url] [![LinkedIn][linkedin-shield]][linkedin-url] - -

@@ -34,33 +32,36 @@

+ +
+ +Table of Contents + - -## Table of Contents - [Development](#development) - - [Setting Up Locally](#setting-up-locally) -- [Project Structure](#project-structure) - - [File Structure](#file-structure) - [Libraries/Frameworks Used](#librariesframeworks-used) -- [Contributing](#contributing) + - [File Structure](#file-structure) + - [Setting Up Locally](#setting-up-locally) - [Contact](#contact) - [Acknowledgements](#acknowledgements) -

(back to top)

+- [Additional Documentation](#additional-documentaiton) + +
## Development -### Setting Up Locally -- Install [NodeJS](https://nodejs.org/en). -- Install or enable [Yarn](https://yarnpkg.com/getting-started/install). -- 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)

+#### Libraries/Frameworks Used + +This project has been built with the following technologies. + +- [React](https://reactjs.dev) +- [Bootstrap](https://getbootstrap.com/) +- [React Router](https://github.com/remix-run/react-router) + +#### File Structure -## Project Structure -### File Structure ``` . ├── public @@ -73,6 +74,7 @@ ├── styles └── App.js ``` + - `public`: Contains public files such as `index.html`. - `src`: Contains source files (JS, CSS, assets, etc.) - `components`: Contains reusable react components. @@ -84,27 +86,13 @@ - `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](https://reactjs.dev) -* [Bootstrap](https://getbootstrap.com/) -* [React Router](https://github.com/remix-run/react-router) - - -

(back to top)

- - - -## Contributing +#### Setting Up Locally -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 +- Install [NodeJS](https://nodejs.org/en). +- Install or enable [Yarn](https://yarnpkg.com/getting-started/install). +- 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)

@@ -112,24 +100,34 @@ Contributions are what make the open source community such an amazing place to b ## Contact > [!Note] -> For any ideas, suggestions or queries regarding the website, mail us at tech.coordi@iitkgp.ac.in +> For any ideas, suggestions or queries regarding the website, mail us at #### Present Technology Coordinator(s) Name|Email|Phone No. -----|-----|--------- -Arpit Bhardwaj | arpitbhardwaj.iitkgp@gmail.com | +91-9761667733 -Parth Gupta | guptaparth.iitkgp@gmail.com | +91-7620821543 +[Arpit Bhardwaj](https://linktr.ee/proffapt) | | +91-9761667733 +[Parth Gupta](https://github.com/ParthGupta2510) | | +91-7620821543

(back to top)

- ## Acknowledgements -* [Img Shields](https://shields.io) -* [GitHub Pages](https://pages.github.com) + +- [Img Shields](https://shields.io) +- [GitHub Pages](https://pages.github.com) +

(back to top)

+## Additional Documentation + +- [Changelogs](/.github/CHANGELOG.md) +- [License](/LICENSE) +- [Security Policy](/.github/SECURITY.md) +- [Code of Conduct](/.github/CODE_OF_CONDUCT.md) +- [Contribution Guidelines](/.github/CONTRIBUTING.md) + +

(back to top)