Skip to content

Commit 7bb22e6

Browse files
Update CONTRIBUTING.md
1 parent 126c874 commit 7bb22e6

1 file changed

Lines changed: 45 additions & 0 deletions

File tree

docs/CONTRIBUTING.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,46 @@
11
# Contribution
2+
3+
## How to Start Contribution
4+
- Fork the repository
5+
- clone the fork by writing the following command
6+
7+
```git
8+
git clone https://github.com/<YOUR USERNAME>/Generate-QR-code.git
9+
```
10+
11+
###### replace \<YOUR USERNAME\> with your profile name of GitHub
12+
13+
- make changes in the fork and push them
14+
- create a pull request
15+
16+
## Local Setup
17+
18+
- ### After running the `git clone` command:
19+
```
20+
cd Generate-QR-code/
21+
```
22+
23+
- ### To install all the dependencies run:
24+
25+
###### if using `yarn`
26+
```terminal
27+
yarn install
28+
```
29+
30+
###### if using `npm`
31+
```terminal
32+
npm install
33+
```
34+
35+
### To start the server:
36+
###### if using `yarn`
37+
```terminal
38+
yarn start
39+
```
40+
41+
###### if using `npm`
42+
```terminal
43+
npm start
44+
```
45+
46+
#### The website can be accessed at: [`https://localhost:3000`](https://localhost:3000)

0 commit comments

Comments
 (0)