Skip to content

Latest commit

 

History

History
44 lines (33 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

44 lines (33 loc) · 1.38 KB

Fork this repository

Fork this repo by clicking on the fork button on the top of this page. This will create a copy of this repository in your account.

Clone the repository

Now clone the forked repository to your machine. Go to your GitHub account, open the forked repo, click on the clone button and then click the copy to clipboard icon.

Open a terminal and run the following git command:

git clone "url you just copied (url of the forked repo)"

where "url you just copied" (without the quote marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url.

For example:

git clone https://github.com/<github_username>/firstcontributions.github.io.git

where <github_username> is your GitHub username. Here you're copying the contents of your firstcontributions.github.io repository on GitHub to your computer.

Running The Project

You should have yarn and node to run the project locally.

Change to the repository directory on your computer (if you are not already there):

cd firstcontributions.github.io

Then install the required Dependencies using:

 yarn install

If you run into a dependencies issue, try removing node_modules.

After installation, run:

yarn start

Now you can open your cloned project at http://localhost:3000/