/wec-nitk-website

This repository contains code for WebClub's Website

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

Web Club website (Frontend)

Tech Stack 🧰

  • Frameworks

  • Pages ☑️

    Home

    • Hero Section
    • What do we do
    • Events
    • FAQ
    • Footer

    Blogs

    • Blogs
    • Reading list

    Teams

    GDSC

    Algorithms

    Systems

    Intelligence

    Installation and Contribution 🧑‍💻

    Using Git and Github

    • Clone the repository
    • Set the upstream remote to the original repository url so that git knows where to fetch updates from in future: git remote add upstream https://github.com/WebClub-NITK/wec-nitk-website.git

    Commit Discipline

    • Make sure to write clear and descriptive commit messages

    • The commit message:

      • is written in the imperative (e.g., "Fix …", "Add …")
      • is kept short (max 76 characters, ideally less), while concisely explaining what the commit does
      • is clear about what part of the code is affected – often by prefixing with the name of the section and a colon, like events: … or footer: …
    • Examples:

      • footer: Add contact links
      • events: Fix scrolling issues

    Install required packages

    • npm install

    Run server

    • npm run dev

    Sample Git Workflow

    • Follow the installation guide to install the software
    • Create a new feature branch with git checkout -b <name-of-your-feature-branch>
    • Make changes and commit them in the feature branch.
    • Once done developing, switch back to the main branch with git checkout main ; pull the latest version of the repo with git pull https://github.com/WebClub-NITK/wec-nitk-website.git main
    • Switch back to the feature branch with git checkout <name-of-your-feature-branch>. Apply the new changes on top of the latest version of the repo with git rebase main
    • Resolve merge conflicts (if any)
    • Push your feature branch upto your remote repo with git push origin <name-of-your-feature-branch>
    • Submit a Pull Request to the main branch.
    • After any questions or changes have been resolved, your contribution would be merged in!