GS-Rourkela-Website

This is the Official website of Girlscript Rourkela Chapter

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

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

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