https://github.com/kvgc153/WebResearcherJS
WebResearcherJS is a web extension which allows users to annotate webpages on the internet.
https://github.com/kvgc153/WebResearcherJS
annotation chrome chrome-extension firefox firefox-extension firefox-webextension javascript joplin jquery research-tool web-annotation web-extension
Last synced: 3 months ago
JSON representation
WebResearcherJS is a web extension which allows users to annotate webpages on the internet.
- Host: GitHub
- URL: https://github.com/kvgc153/WebResearcherJS
- Owner: kvgc153
- License: mit
- Created: 2022-02-02T07:42:39.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-10T03:41:04.000Z (about 1 year ago)
- Last Synced: 2024-08-10T04:36:09.301Z (about 1 year ago)
- Topics: annotation, chrome, chrome-extension, firefox, firefox-extension, firefox-webextension, javascript, joplin, jquery, research-tool, web-annotation, web-extension
- Language: JavaScript
- Homepage:
- Size: 21.3 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-editorjs - WebResearcherJS - Firefox extension which allows users to take notes on webpages (Projects Using Editor.js / Plugins for CMS)
README
## WebResearcher-notes 
Sticky notes for the web.
## Getting Started
- Download the WBJS Sticky Notes extension. Available on [Firefox](https://addons.mozilla.org/en-US/firefox/addon/webresearcherjs/).
- **Local server**: All the notes taken on the browser using the extension will be saved to a server running locally.
```shell
git clone https://github.com/kvgc153/WebResearcherJS-extension.git
cd WebResearcherJS-extension/wbjs-server/
npm install
```
- **Registering extension with server**: Visit `about:debugging#/runtime/this-firefox` and grab the Manifest URL of the WBJS Sticky Notes extension (starts with moz-extension://) and paste it in wbjs-server/registeredUsers.json. If you install the extension in multiple browsers, add the manifest URL of all the installed extensions.
Here's an example how one such registeredUses.json file would look like for two firefox instances:
```javascript
["moz-extension://03cc1dfa-xxxx-aaaa-qqqq-8d4435yy948d/","moz-extension://f8c42426-yyyy-zzzz-rrrr-17a1231ee6fa/"]
```
Start the server
```shell
node server.js
```
Multiple sqlite DBs will be created in the same folder which will contain all the notes taken by the extension. Check that this exists in the folder before proceeding further.
## How to take notes using WebResearcher-notes?
1. **Create a Note:** Navigate to your favorite webpage (here's an [example](https://en.wikipedia.org/wiki/Foobar)).Click on the 'Make Note' button to start a note.
2. **Move Note:** Drag the note around the page by holding down the left mouse button and moving your mouse.
3. **Add tags:** Add relevant tags to your note for easy organization.
4. **Saving notes**: Save notes to server by pressing the save button (or Alt+S/Cmd+S). The notes will be automatically displayed the next time you visit the page.
5. **Link notes**: Link to existing notes.
5. **View all notes** : Visit [http://127.0.0.1:3000/notesViewer](http://127.0.0.1:3000/notesViewer) to view and search all the notes taken.
You can also view a graph network of your notes by clicking on the 'View graph' button
The query string `q` can also be used to search the notes.
Example usage:
```
http://127.0.0.1:3000/notesViewer?q=test
```
Click [here](featuresAll.md) to learn about all the features of WBJS and [here](developerNotes.md) for developer notes.
# Buy me a Coffee :coffee:
If you like this project and would like to support this work, please consider [buying me a cup of coffee](https://buymeacoffee.com/509si1f).