Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md with correct installation setup #427

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 121 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,27 +12,141 @@ Website built with Webiu: https://www.scorelab.org/

The project is based on ReactJs, JavaScript and GatsbyJs. You need to make sure that you have compatible versions of node/yarn, npm installed. SASS as the stylesheet is used in this project.

## Initial Setup
### Local Development Setup

You will need to have Gatsby CLI installed into your system
Go to the offical Gatsby documentation and proceed further to set up the Gatsby CLI https://www.gatsbyjs.com/docs/tutorial/

#### Project Dependencies

This project relies on the dependencies as well.

Name | Version |
--- | --- |
node | `14.17.4` |
npm | `6.14.14` |
Gatsby CLI | `4.0.0` |

You might require nvm (Node Version Manager) if you are dealing with multiple versions of Nodejs.

#### Installing Dependencies in **Ubuntu/Debian**

```
# Install nvm
sudo apt install curl
curl https://raw.githubusercontent.com/creationix/nvm/master/install.sh | bash

source ~/.bashrc

# Install specific node version. This will also install npm version 6.14.14
nvm install 14.17.4

# To use node in the current shell session
nvm use 14.17.4

#Install Gatsby CLI
npm install -g gatsby-cli@4.0.0
```

#### Installing Dependencies in **Windows**

* Remove any existing versions of node which you might have installed.

* Head over to [nvm-windows](https://github.com/coreybutler/nvm-windows/releases) and download the latest **nvm-setup.exe** file.

* Install **nvm-setup.exe** file and confirm the installation by running `nvm -v` in Command Prompt.

* Now open Powershell or Command Prompt with administrator permissions, and run the following commands:

```
# Install specific node version. This will also install npm version 6.14.14
nvm install 14.17.4

# To use the node version which you have installed
nvm use 14.17.4

#Install Gatsby CLI
npm install -g gatsby-cli@4.0.0
```

#### Installing Dependencies in **MacOS**

* Remove any existing versions of node which you might have installed.

* You will need Homebrew on your MacOS. After that follow the steps given below:

```
# Install nvm
brew update
brew install nvm
mkdir ~/.nvm

echo "export NVM_DIR=~/.nvm\nsource \$(brew --prefix nvm)/nvm.sh" >> .zshrc
source ~/.zshrc

# Install specific node version. This will also install npm version 6.14.14
nvm install 14.17.4

# To use the node version which you have installed
nvm use 14.17.4

#Install Gatsby CLI
npm install -g gatsby-cli@4.0.0
```

After installing dependencies, check their versions by using these commands

```
# Node version: 14.17.4
node -v

# npm version: 6.14.14
npm -v

# Gatsby CLI version: 4.0.0
gatsby --version
```

## Project Setup

Fork the repository as your own copy
`https://github.com/ <Your Username> /Webiu.git`

Clone the repository in your local system
`git clone https://github.com/ <Your Username> /Webiu.git`

## Local Development Setup

You will need to have Gatsby CLI installed into your system
Go to the offical Gatsby documentation and proceed further to set up the Gatsby CLI https://www.gatsbyjs.com/docs/tutorial/

#### Cd into the project
#### cd into the project

`cd Webiu`

#### Install All Dependencies

`npm install`

#### Add `variables.sass` file

* In `src/styles/` folder create a new file named `variables.sass`.

Add the following contents to it and save the file:

```
$text-color: #242526;
$primary: #54AD28;
$light-secondary: #E6ECEE;
$secondary: #24598B;
$dark-grey: #666666;
$grey: #808080;
$light-grey: #D3D3D3;
$very-light-grey: #C9C9C9;
$red: #F24423;
$very-dark-grey: #63676A;
$xs-and-less: (min-width: 576px);
$tiny-and-less: (min-width: 768px);
$md-and-less: (min-width: 992px);
$sm: (min-width: 576px);
$sm-and-less: (max-width: 576px)
```

#### Errors if any?

Got Stuck? Don't forget to give a look to the troubleshooting guides https://www.gatsbyjs.com/docs/how-to/local-development/troubleshooting-common-errors/
Expand Down