Skip to content

Commit f1f49fd

Browse files
authored
โ˜• chore: add setup instructions
1 parent 6deee12 commit f1f49fd

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

โ€Žcontributing.mdโ€Ž

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,25 @@ There are many ways to contribute to this open source project. Any contributions
1414

1515
If you can write a code then create a pull request to this repo and I will review your code. Please consider to submit your pull request to the ```dev``` branch. I will auto reject if you submit your pull request to the ```main``` branch.
1616

17+
#### ๐Ÿ”ง Setup
18+
19+
**To install the CLI app** in your working directory, you can run the following command:
20+
21+
```bash
22+
yarn setup
23+
```
24+
25+
OR
26+
27+
```bash
28+
npm run setup
29+
```
30+
31+
Run the command everytime you make changes to the code. This will build the project and install the CLI app in your working directory. So you can test it out using `magicc` command.
32+
33+
> [!IMPORTANT]
34+
> When using the setup command please ensure you are using linux-based OS. This command will use commands tht are only available in linux-based OS. Such as `rm -rf` to delete the `dist` folder.
35+
1736
### ๐Ÿ“– Documentation
1837

1938
(coming soon)
@@ -24,4 +43,4 @@ For any security bugs or issues, please read the [security policy](./security.md
2443

2544
---
2645

27-
๐Ÿ’ป with โค๏ธ by [Waren Gonzaga](https://warengonzaga.com) and [Him](https://www.youtube.com/watch?v=HHrxS4diLew&t=44s) ๐Ÿ™
46+
๐Ÿ’ป with โค๏ธ by [Waren Gonzaga](https://warengonzaga.com) and [Him](https://www.youtube.com/watch?v=HHrxS4diLew&t=44s) ๐Ÿ™

0 commit comments

Comments
ย (0)