Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mozilla/notes
DEPRECATED - A notepad for Firefox
https://github.com/mozilla/notes
abandoned unmaintained
Last synced: about 2 months ago
JSON representation
DEPRECATED - A notepad for Firefox
- Host: GitHub
- URL: https://github.com/mozilla/notes
- Owner: mozilla
- License: mpl-2.0
- Archived: true
- Created: 2017-05-12T09:12:56.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-09-17T20:02:34.000Z (almost 4 years ago)
- Last Synced: 2024-04-13T19:07:46.009Z (5 months ago)
- Topics: abandoned, unmaintained
- Language: HTML
- Homepage: https://testpilot.firefox.com/experiments/notes
- Size: 25 MB
- Stars: 493
- Watchers: 42
- Forks: 130
- Open Issues: 100
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Firefox Notes
A notepad for Firefox
[](https://circleci.com/gh/mozilla/notes/tree/master)
[](https://testpilot.firefox.com/experiments/notes)
> Discussion Forum: [https://discourse.mozilla.org/c/archives/test-pilot](https://discourse.mozilla.org/c/archives/test-pilot)
## Releases
The releases are packaged by CircleCI for [Android](https://app.circleci.com/pipelines/github/mozilla/notes/20/workflows/239f8590-cfae-491b-9db7-30971c73fd9a/jobs/3294/artifacts) and the [WebExtension](https://app.circleci.com/pipelines/github/mozilla/notes/20/workflows/239f8590-cfae-491b-9db7-30971c73fd9a/jobs/3292/artifacts).
## Contribute
* Step 0: If you plan on sending a pull-request, you should fork the repository.
* Step 1: Clone the [notes](https://github.com/mozilla/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](https://github.com/mozilla/notes/blob/master/RELEASE.md) for release steps.
### Localization
Firefox Notes localization is managed via [Pontoon](https://pontoon.mozilla.org/), 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](https://pontoon.mozilla.org/teams/) for your language, or Mozilla’s [l10n-drivers](https://wiki.mozilla.org/L10n:Mozilla_Team#Mozilla_Corporation) for guidance.
## Licenses
* [Mozilla Public License Version 2.0](LICENSE)
* [CKEditor Text Editor License](https://github.com/ckeditor/ckeditor5/blob/master/LICENSE.md) used under MPL licence
## Design
* Design for reference: https://mozilla.invisionapp.com/share/6VBUYHMRB#/281041484_Firefox_Notes
* Mobile design for reference: https://mozilla.invisionapp.com/share/BTGS26C2FE4
## Screenshot
