piyush3443code / hacktoberfest-2022

Forked for Hactober

Hacktoberfest 2022

Website for Hacktoberfest 2022

View Live · Report Bugs . Add Features

Table of Contents

1. Built With
2. Hacktoberfest
3. Getting Started
   • Prerequisites
   • Contribution guidelines
   • Local Repository Setup
   • Running the project
4. License
5. DSC NIT Rourkela
6. Starware

Built With

Following technologies and libraries are used for the development of this website

• React
• Graphql

Hacktoberfest

Hacktoberfest is a month-long celebration of open source software run by DigitalOcean in partnership with GitHub and Twilio. Hacktoberfest is open to everyone in our global community!

Getting Started

To setup the project locally the steps below.

Prerequisites

• Node.js

  # Homebrew
  brew install nodejs
  
  # Sudo apt
  sudo apt install nodejs
  
  # Packman
  pacman -S nodejs
  
  # Module Install
  dnf module install nodejs:<stream> # stream is the version
  
  # Windows (chocolaty)
  cinst nodejs.install
  

• Yarn

  npm install --global yarn

• Git

  # Homebrew
  brew install git

  # Sudo apt
  apt-get install git

  # Packman
  pacman -S git

  # Module Install (Fedora)
  dnf install git

Contribution guidelines

---

Our Slack Community: Slack Invite

Contributions are welcome 🎉🎉

Local Repository Setup

Please refer to the project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

1. Fork the repo on GitHub
2. Clone the project to your local system
3. Commit changes to your own separate branch
4. Push your work back up to your fork
5. Submit a Pull request so that we can review your changes

Steps to add a Member Card

• Locate the member.js in the src file
• Add your details in the following format

  Example ->
  {
    github: 'riteshsp2000',
    twitter: 'https://twitter.com/riteshsp2000',
    linkedin: 'https://linkedin.com/in/riteshsp2000',
    portfolio: 'https://riteshpatil.dev',
  },

Running the project.

The project uses Yarn and not NPM. It is strictly advised to stick with Yarn so as to avoid dependency conflicts down the line.

## Install Dependencies
yarn install

## Run the Project
yarn develop

Following are the commands to remove/add new dependencies using yarn

## Add a new Package
yarn add package_name

## Remove an existing Package
yarn remove package_name

## Save Package as a Dev Dependency
yarn add -D package_name

License

Distributed under the MIT License. See LICENSE for more information.

DSC NIT Rourkela

Project developed and maintained by DSC NIT Rourkela

Starware

dscnitrourkela/project-icecream is Starware. This means you're free to use the project, as long as you star its GitHub repository. Your appreciation makes us grow and glow up. ⭐