Skip to content

Latest commit

 

History

History
83 lines (53 loc) · 2.93 KB

README.md

File metadata and controls

83 lines (53 loc) · 2.93 KB

GDSC Club Official Website 🌟

Welcome to the official repository for the Google Developer Student Clubs (GDSC) website of IIITL 🎓. This repository is a dedicated platform that bridges theoretical knowledge with practical application, offering a comprehensive view of our club's activities and initiatives.

Table of Contents 📚

Introduction 🌟

The GDSC club at IIITL is committed to enhancing technical proficiency by providing a platform for hands-on experience and learning. This repository encapsulates the codebase and resources for our official website, ensuring transparency and collaboration among our members.

Getting Started 🏁

To engage with this project, please follow the outlined steps:

Prerequisites 📋

  1. Git: Ensure you have Git installed on your local machine. If not, download and install Git.
  2. Node.js and npm: The project utilizes Node.js and npm for package management. Install these tools from the official Node.js website.

Setup 🛠️

  1. Clone the repository:

    git clone https://github.com/DSC-IIITL/gdsc-iiitl-official.git
  2. Navigate to the project directory:

    cd gdsc-iiitl-official
  3. Install project dependencies:

    yarn

Running Locally 🖥️

Execute the following command to run the website locally:

yarn dev

Access the website by navigating to http://localhost in your web browser.

Encountering issues? For assistance or troubleshooting, refer to our wiki or create an issue for support.

Contributing 🌱

Your contributions are invaluable to us! To contribute effectively:

  1. Fork this repository.
  2. Create a new branch: git checkout -b feature/your-feature-name.
  3. Implement your changes and commit them: git commit -m 'Add some feature'.
  4. Push your changes to the branch: git push origin feature/your-feature-name.
  5. Submit a pull request for review.

Ensure adherence to our Contributing Guidelines and uphold our Code of Conduct during your contributions.

Wiki Pages 📖

For comprehensive documentation, guidelines, and resources, please visit our Wiki Pages.

License 📜

This project is licensed under the MIT License. For more details, refer to the LICENSE file.

We look forward to your contributions and collaboration!