Skip to content

Commit

Permalink
docs: add README.md for web clipper (streetwriters#7054)
Browse files Browse the repository at this point in the history
Signed-off-by: 01zulfi <[email protected]>
  • Loading branch information
01zulfi authored Dec 5, 2024
1 parent 93af799 commit 75c346a
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions extensions/web-clipper/README.md
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.

0 comments on commit 75c346a

Please sign in to comment.