Skip to content

Commit 66b8840

Browse files
author
Veekas Shrivastava
committed
feat: add instructions to run locally to readme
1 parent 8b53ad9 commit 66b8840

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

+23-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## CodeMode overview
44

5-
CodeMode is a Google Chrome extension that turns any Youtube coding tutorial into an interactive learning platform.
5+
CodeMode is a Google Chrome extension that turns any Youtube coding tutorial into an interactive learning platform. Activate CodeMode by [installing the extension on the Chrome Web Store](https://chrome.google.com/webstore/detail/code-mode/lojikgkcpdeolbgbfcapfpfhofkocnge).
66

77
![CodeMode intro gif](public/intro.gif)
88

@@ -26,6 +26,28 @@ You can [view the CodeMode product demo on Youtube](https://youtube.com/watch?v=
2626

2727
![CodeMode product demo on Youtube](public/youtube.jpeg)
2828

29+
30+
# For developers
31+
32+
## How to run CodeMode locally
33+
34+
- Open your terminal window, navigate to your desired directory, and type the following:
35+
```bs
36+
> git clone [email protected]:World-of-Code/code-mode.git
37+
> cd code-mode
38+
> yarn
39+
> yarn run start-dev
40+
```
41+
- Open up Chrome and go to `chrome://extensions`.
42+
- Make sure the 'Developer Mode' checkbox is on
43+
- Click 'Load unpacked extension...'
44+
- Navigate to the folder with CodeMode's `manifest.json` file and click 'Select'
45+
- Now you should be able to navigate to [any Youtube video](https://www.youtube.com/watch?v=H9oYe_8Ks9M) and see the CodeMode drawer at the bottom of the page!
46+
47+
## Known issues
48+
49+
- When multiple Youtube videos are open in separate tabs, CodeMode forces each page to reload continuously.
50+
2951
## Contribution guide
3052

3153
- Make an issue (or multiple issues)

0 commit comments

Comments
 (0)