forked from streetwriters/notesnook
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add README.md for web clipper (streetwriters#7054)
Signed-off-by: 01zulfi <[email protected]>
- Loading branch information
Showing
1 changed file
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Contributing guidelines | ||
|
||
Please read the [contributing guidelines](../../CONTRIBUTING.md) beforehand. | ||
|
||
### Setting web clipper locally | ||
|
||
#### Running the web clipper | ||
|
||
1. Install packages and setup the repo. Run this command in the repository root: | ||
```sh | ||
npm install | ||
``` | ||
1. Run the Notesnook webapp: | ||
```sh | ||
npm run start:web | ||
``` | ||
1. Navigate to the web clipper folder: | ||
```sh | ||
cd extensions/web-clipper | ||
``` | ||
1. Run the web clipper: | ||
```sh | ||
npm run dev:chrome | ||
``` | ||
|
||
#### Viewing the web clipper | ||
|
||
1. Open chrome and go to `chrome://extensions`. | ||
1. Turn on "Developer Mode". | ||
1. Click on "Load unpacked" and select the `extensions/web-clipper/build` folder. |