Skip to content

iot-lab-kiit/intern-fair

Repository files navigation

GuideLy

GuideLy is a web application designed to help students learn and get guidance in various domains such as web development, app development, competitive programming (CP), machine learning (ML), information technology (IT), and more. It also showcases the legacy of our IoT Lab.

GuideLy Features

Features

  • Domain-Specific Learning Paths: Curated learning paths for different domains that guide students from beginner to advanced levels. Learning Paths

  • Community Support: A platform to join a community of like-minded learners for collaboration and knowledge sharing. Community Support

  • Resource Library: A comprehensive resource library that includes articles, videos, and documentation. Resource Library

Installation

To run the application locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/iot-lab-kiit/intern-fair.git
    cd client
  2. Install dependencies:

    yarn install
  3. Set up environment variables:

    Create a .env file in the root of the client directory with the necessary environment variables.

  4. Run the application:

    yarn run dev
  5. Access the application:

    Open your browser and navigate to http://localhost:3000 to view the app.


Contributing to GuideLy (Hacktoberfest)

GuideLy welcomes contributions from the open-source community, especially during Hacktoberfest! Here's how you can contribute:

  1. Choose an Issue:

    Browse the issue tracker to find issues labeled with Hacktoberfest or good first issue.

  2. Fork the Repository:

    Create a fork of the repository by clicking the Fork button on the top-right corner of the project.

  3. Create a Branch:

    Use the following commands to create a new branch for your contribution:

    git checkout -b your-branch-name
  4. Make Your Changes:

    Work on the issue you've selected. Make sure your code follows best practices and is well-documented.

  5. Test Your Changes:

    Before submitting your changes, ensure they work as expected by running the app locally:

    yarn run dev
  6. Submit a Pull Request (PR):

    Once you're satisfied with your changes, push them to your forked repository and create a pull request:

    git push origin your-branch-name

    Go to the original repository and click on New Pull Request. Be sure to link the issue you worked on.

  7. Get Feedback and Collaborate:

    Your pull request will be reviewed by the maintainers. Feel free to respond to feedback, ask questions, and collaborate on improving your submission!

Hacktoberfest Guidelines

  • Ensure that your pull request adheres to the Hacktoberfest rules.
  • Only meaningful contributions will be counted towards Hacktoberfest.
  • If you have any questions or need help, feel free to ask in the project's discussion board or open a new issue.

Happy coding and welcome to the GuideLy community!