Skip to content

Noteworthy-Extension/Noteworthy-App

Repository files navigation


Logo

Noteworthy App

A note-taking app that lets you annotate any website.

Download the extension in the chrome web store · Report a bug

Table of Contents

  1. About The Project
  2. Getting Started
  3. License
  4. Contact
  5. Acknowledgments

About The Project

Noteworthy is a browser-based extension that allows you to make annotations and take notes on any website. It has many features, from text to drawing, that all work on any website. With local storage, the notes you take are saved locally to your device so that the notes load when you visit the site again.

Features

Noteworthy has many features giving you as much freedom to annotate the website as if it was a piece of paper.

With Noteworthy you can annotate the page with:

  • Drawing
  • Highlighting
  • Shapes
  • Lines
  • Arrows
  • Textboxes

Built With

We built our app with pure Typescript to ensure code security, then we transpile our code to JS. We also used pure Sass which allows more complex visual styling and makes it easier for the app to not conflict with the website. After compiling it to code that the browser can read, we bundled our code into one minified file with Gulp. This is the file that we use for the chrome extension.

  • TypeScript
    TypeScript
  • Sass
    Sass
  • Gulp
    Gulp

Getting Started

This is a guide on a few ways to install the extension.

Installation

There are a few ways to install Noteworthy:

  1. Chrome Webstore

    The Chrome Webstore is the easiest way to install Noteworthy but sometimes updates get delayed. First, go to the app's page on the Chrome Webstore. Click install, go to a page and click on the extension. A dropdown should open which will allow you to markdown the page. Once you're done, you can leave the page, and all of your notes will stay when you return.

  2. From the source

    Git clone the src repo, then go to chrome://extensions and click "load unpacked extension". Click the folder that you cloned, then dist, then click OK. This will load the extension in and you can use it normally.

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

If you have a question or anything to say, contact us here:

Project Link: https://github.com/Noteworthy-Extension/Noteworthy-App

Acknowledgments

A list of some of the tools and resources we used to make our app.

Developers

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •