roflinn / notes Goto Github PK

View Code? Open in Web Editor NEW

This project forked from mozilla/notes

A notepad for Firefox

License: Mozilla Public License 2.0

HTML 75.86% JavaScript 20.24% CSS 0.52% Shell 0.18% Java 1.65% Objective-C 0.33% Starlark 0.18% SCSS 1.05%

notes's Introduction

Firefox Notes

A notepad for Firefox

Discussion Forum: https://discourse.mozilla.org/c/archives/test-pilot

Releases

The releases are packaged by CircleCI for Android and the WebExtension.

Contribute

Step 0: If you plan on sending a pull-request, you should fork the repository.
Step 1: Clone the notes repository or your fork.

git clone https://github.com/mozilla/notes.git
# or
git clone https://github.com/[yourusername]/notes.git

Step 2: Navigate to the root of the directory you cloned and run:

Make sure to use Node.js 8+.

Command	Description
`npm install`	Installs required Node.js dependencies.
`npm run build`	Builds the application as a Web Extension.
`npm start`	Launches Firefox with the Web Extension.

You can also open the test/index.html file in your browser to run the automated tests.

WebExtension Permissions

Permission	Description
`contextMenus`	Used for "Send to Note" feature, sends text from pages to the Notes sidebar.
`storage`	Storage for Notes.
`identity`	OAuth login to Firefox Accounts to sync your notes.

Release

See RELEASE.md for release steps.

Localization

Firefox Notes localization is managed via Pontoon, not direct pull requests to the repository. If you want to fix a typo, add a new language, or simply know more about localization, please get in touch with the existing localization team for your language, or Mozilla’s l10n-drivers for guidance.