Skip to content

Latest commit

 

History

History
55 lines (32 loc) · 2.13 KB

README.md

File metadata and controls

55 lines (32 loc) · 2.13 KB

WebResearcher-notes

Actively engage with webpages by annotating with WebResearcher-notes.

Getting Started

  • Download the WBJS Sticky Notes extension. Available on Firefox.

  • Local server: All the notes taken on the browser using the extension will be saved to a server running locally.

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.
node server.js

A sqlite DB 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 procedding further.

How to take notes using WebResearcher-notes?

  1. Create a Note: 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.

  1. Saving notes: Save notes to server by pressing the save button. The notes will be automatically displayed the next time you visit the page.

  2. View all notes : Visit http://127.0.0.1:3000/notesViewer to view and search all the notes taken.

The query string q can also be used to search the notes. Example usage:

http://0.0.0.0:3000/notesViewer?q=test

Click here to learn about all the features of WBJS and here for developer notes.

Buy me a Coffee ☕

If you like this project and would like to support this work, please consider buying me a cup of coffee.