Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeremy committed Dec 2, 2020
1 parent 5e378a6 commit 1db129a
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,15 +72,25 @@ And that's what LeetHub is supposed to do: indirectly improving your coding skil
![leetcode view](assets/extension/leetcode.png)


# How to get LeetHub to work locally?
# How to set up LeetHub for local development?

<ol>
<li>Fork this repo</li>
<li>Fork this repo and clone to your local machine</li>
<li>Go to <a href="chrome://extensions">chrome://extensions</a> </li>
<li>Enable <a href="https://www.mstoic.com/enable-developer-mode-in-chrome/">Developer mode</a> by toggling the switch on top right corner</li>
<li>Click 'Load unpacked'</li>
<li>Select the entire LeetHub folder</li>
<li>Run "npm run setup" to install the developer dependencies</li>
</ol>

Other npm commands available:

```
npm run Show list of commands available
npm run format Auto-format JavaScript, HTML/CSS
npm run format-test Test all code is formatted properly
npm run lint Lint JavaScript
npm run lint-test Test all code is linted proprely
```

#### And that should be it! Get Hacking...

0 comments on commit 1db129a

Please sign in to comment.