Skip to content
This repository has been archived by the owner on Feb 29, 2024. It is now read-only.

Latest commit

 

History

History
55 lines (40 loc) · 3.17 KB

README.md

File metadata and controls

55 lines (40 loc) · 3.17 KB
Raw

HackRPI-Website2023

Welcome to the official GitHub repository for hackrpi.com, the home of HackRPI's 10th annual hackathon, HackRPI X! Over the past decade, HackRPI has grown into one of the most prestigious hackathons, providing a platform for innovation, collaboration, and creativity. As we celebrate this milestone, we invite you to be a part of this journey.

🎉 Join the Celebration!

We're thrilled to see the HackRPI community grow each year and are always on the lookout for fresh ideas and perspectives. Whether you're a seasoned developer, a design enthusiast, or someone who's just passionate about hackathons, there's a place for you here!

🖐 How Can You Contribute?

  1. Bug Fixes: Spot an issue? Feel free to submit a pull request.
  2. Feature Suggestions: Got an innovative idea for the website? Raise an issue, and let's discuss it!
  3. Design Improvements: If you're a design enthusiast, your insights can give the website a fresh and innovative look.
  4. Documentation: Help make our documentation clearer and more comprehensive for future contributors.
  5. Outreach: Share the website and gather feedback, helping us reach a broader audience.
  6. Connect with Us: Reach out to our organizing team on Discord and ask the technology team for tasks or any assistance.

🛠 Getting Started

Recommended Tools:

Steps:

  1. Clone the Repository:

    • Using GitHub Desktop, choose File > Clone repository and select the HackRPI repository. This will create a local copy on your machine.

  2. Create a New Branch:

    • Once the repository is cloned, create a new branch in GitHub Desktop.
    • For features, use the naming convention: feature/your-feature-description.
    • For bugs, use the naming convention: bug/your-bug-description.

  3. Implement and Commit Changes:

    • Make the necessary changes in your branch. Use Visual Studio Code or your preferred editor.
    • Add comments!!
    • Once done, commit your changes using GitHub Desktop.

  4. Update with Main:

    • Before pushing your changes, ensure you have the latest version of main. In GitHub Desktop, pull the latest changes from the main branch and merge them into your branch.

  5. Test Your Changes:

    • Ensure your design is responsive. Test on multiple screen sizes, including mobile. Employ best practices for responsive design.

  6. Push and Create a Pull Request:

    • Push your branch to GitHub using GitHub Desktop.
    • Then, visit the repository on GitHub's website and create a pull request. Write a description of the changes in the comment, and paste any relevant images showcasing updates. Our team will review, provide feedback, or merge your changes.

⏯️ Running Locally

  1. Navigate to your cloned repository
  2. Run npm install to install/update packages
  3. Run npm start to start the app
  4. Go to localhost:3000 or the port that is mentioned when the app starts up
  5. Enjoy the view! 😎 (and debug)