HTML JavaScript Java CSS Objective-C Shell Python
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin first pass at a build-addon script Jul 12, 2017
ckeditor-build Update to latest CKEditor (#1191) Jun 23, 2018
docs Implement all GA events (#1033) May 7, 2018
locales Pontoon: Update Chinese (China) (zh-CN) localization of Test Pilot: N… Aug 16, 2018
native Prevent two sign-in windows from opening on Android (#1349) Aug 9, 2018
scripts Update to latest CKEditor (#1191) Jun 23, 2018
src Bump version to 4.3.0dev (#1308) Jul 24, 2018
test/unit Replace cryptographer with node-jose in the webextension (#1184) Jun 21, 2018
.babelrc Refactor scaffolding of sidebar to prepare React integration Jan 5, 2018
.eslintignore Fixing some ESLint paths now that we're using a /vendor/ directory (#80) Jun 16, 2017
.eslintrc.yml Lock eslint versions and add package lock (#1174) Jun 18, 2018
.gitignore Update to fxa-crypto-relier 2.3.0 everywhere (#1126) Jun 1, 2018
.nvmrc Update .nvmrc Mar 16, 2018
.stylelintrc Add stylelint support for SCSS/CSS linting Feb 14, 2018
.taskcluster.yml Revert "Target SDK 26 in Android" (#1120) May 31, 2018
.travis.yml Use npm 6 to install things Jun 27, 2018
CHANGELOG.md Back to development (#1141) Jun 8, 2018
CODEOWNERS Add CODEOWNERS for l10n reviews Nov 24, 2017
LICENSE Cleaning space on empty lines. (#248) Sep 27, 2017
README.md Update nodejs version May 22, 2018
RELEASE.md Update RELEASE.md Feb 14, 2018
circle.yml Update artifact file name Jul 31, 2018
karma.conf.js Use mocha reporter Oct 10, 2017
l10n.toml Add l10n.toml (#174) Jul 27, 2017
package-lock.json Update to latest CKEditor (#1191) Jun 23, 2018
package.json Bump version to 4.3.0dev (#1308) Jul 24, 2018
webpack.config.js Update to fxa-crypto-relier 2.3.0 everywhere (#1126) Jun 1, 2018
webpack.test-unit.js Use webpack to build unit tests Oct 6, 2017

README.md

Firefox Notes

A notepad for Firefox

CircleCI Available on Test Pilot

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

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.

Licenses

Design

Screenshot

Notes v4