Music Editor
Introduction
The Music Editor is an unofficial editor for Standard Notes, a free, open-source, and end-to-end encrypted notes app.
Try the demo at demo.musiceditor.net or learn more at musiceditor.net.
The Music Editor is used to write music and guitar tablature using VexTab.
For a full tutorial on how to use VexTab, please see the official tutorial.
The Music Editor is built with React, TypeScript, Sass, VexTab, and VexFlow.
Features
- Write music and guitar tablature using VexTab.
- Three modes: Edit, Split, and View.
- Save as PDF using Microsoft Edge or Chrome.
Installation
- Register for an account at Standard Notes using the Desktop App or Web app. Remember to use a strong and memorable password.
- In the bottom left corner of the app, click Extensions.
- Click Import Extension.
- Paste this into the input box:or paste this into the input box on desktop:
https://notes.theochu.com/p/Sfq1jJV0X2
https://raw.githubusercontent.com/TheodoreChu/music-editor/main/public/demo.ext.json
- Press Enter or Return on your keyboard.
- Click Install.
- At the top of your note, click Editor, then click Music Editor.
- When prompted to activate the extension, click Continue.
After you have installed the editor on the web or desktop app, it will automatically sync to your mobile app after you sign in.
Development
Prerequisites: Install Node.js, Yarn, and Git on your computer.
The general instructions setting up an environment to develop Standard Notes extensions can be found here. You can also follow these instructions:
- Fork the repository on GitHub.
- Clone your fork of the repository.
- Run
cd music-editor
to enter themusic-editor
directory. - Run
yarn install
to install the dependencies on your machine as they are described inyarn.lock
.
Testing in the browser
- To run the app in development mode, run
yarn start
and visit http://localhost:3001. Pressctrl/cmd + C
to exit development mode.
Testing in the Standard Notes app
- Create an
ext.json
in thepublic
directory. You have three options:- Use
sample.ext.json
. - Create
ext.json
as a copy ofsample.ext.json
. - Follow the instructions here with
url: "http://localhost:3000/index.html"
.
- Use
- Install http-server using
sudo npm install -g http-server
then runyarn server
to serve the./build
directory at http://localhost:3000. - To build the app, run
yarn build
. - Install the editor into the web or desktop app with
http://localhost:3000/sample.ext.json
or with your customext.json
. Pressctrl/cmd + C
to shut down the server.
Deployment
- To make the source code prettier, run
yarn pretty
. - To the deploy the build into the
gh-pages
branch of your repository on GitHub, runyarn deploy-stable
. - To deploy the build into to the
dev
branch for testing, runyarn deploy-dev
. - To deploy the built into the
build
branch for distributing, runyarn deploy-build
for distributing builds.
This project was bootstrapped with Create React App.
Available Scripts
In the project directory, you can run:
yarn start
Runs the app in the development mode.\ Open http://localhost:3001 to view it in the browser.
The page will reload if you make edits.\ You will also see any lint errors in the console.
yarn test
Launches the test runner in the interactive watch mode.\ See the section about running tests for more information.
yarn build
Builds the app for production to the build
folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.\ Your app is ready to be deployed!
See the section about deployment for more information.
yarn eject
Note: this is a one-way operation. Once you eject
, you can't go back!
If you aren't satisfied with the build tool and configuration choices, you can eject
at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject
will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
You don't have to ever use eject
. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
Learn More
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
License
Copyright (c) Theodore Chu. All Rights Reserved. Licensed under AGPL-3.0 or later.
Acknowledgements
Early stages of this editor were based heavily on the Standard Notes Markdown Basic Editor. The Markdown Basic Editor is licensed under AGPL-3.0 and is available for use through Standard Notes Extended.
Further Resources
- GitHub for the source code of the Music Editor
- GitHub Issues for reporting issues concerning the Music Editor
- Docs for how to use the Music Editor
- Contact for how to contact the developer of the Music Editor
- Music Editor To do List for the roadmap of the Music Editor
- Standard Notes Slack for connecting with the Standard Notes Community
- Standard Notes Help for help with issues related to Standard Notes but unrelated to this editor