avishrantssh / spec-frontend

The frontend of SPEC website

SPEC NITH

Official Codebase
Report Bug · Request Feature

📝 General Overview

This is the official website for Society for Promotion of Electronics Culture (SPEC), NIT Hamirpur from 2021 onwards. SPEC is run under the aegis of Electronics and Communication Department of NITH and is renowned for conducting a national level hackathon ELECTROTHON along with a plethora of workshops, competitions, guest talks and the annual technical fest - SPECFEST.

Visit the current official website of SPEC from here.

⚙️ Installation and Set-Up

• Make sure you have a valid Node.js installation on your machine. Alternatively, you can use the following commands:

  • For Ubuntu\Debian:

    sudo apt install npm
    

  • For Arch:

    sudo pacman -S npm-lts
    

• Install Gatsby command line interface (Optional):

  npm install -g gatsby-cli
  

• Install all dependencies for the project using:

  npm install
  

• To start site at localhost, use:

  gatsby develop
  

  or

  npm run start
  

• The server runs on port 8000. It can be accessed from the browser at

  https:\\localhost:8000
  

Note: You can read more about gatsby from Official Gatsby Documentation

🎯 Contributing Guidelines

Contributions are what make the open source community such an amazing place to learn, inspire and build experiences that are cherished for a lifetime. Go ahead and follow these steps to contribute to the community.

• Fork this repository by clicking on Fork button on the top right side.

• Clone your Fork to your local machine

  git clone [https://github.com/your-username/spec-frontend.git]
  

• Create your Feature Branch

  git checkout -b [branch-name]
  

• Make your changes and commit them

  git add . 
  git commit -m "Add some amazing feature" 
  

• To check the status

  git status
  

• And then push the changes to your forked repository

  git push origin [branch name]
  

• Click on the New Pull Request button at the top of your repository to create a new pull request from your forked repository.

• Wait for your PR review and merge approval.

• Don't forget to ⭐ this repository.