Skip to content

Commit

Permalink
Intial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
TheodoreChu committed Dec 4, 2020
1 parent 044c467 commit a597979
Show file tree
Hide file tree
Showing 65 changed files with 14,834 additions and 1 deletion.
25 changes: 25 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -102,3 +102,28 @@ dist

# TernJS port file
.tern-port

# Copied from Create React App
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
#/build

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
3 changes: 3 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"singleQuote": true
}
3 changes: 3 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
Music Editor
Copyright (C) 2020, Theodore Chu. All Rights Reserved.

GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007

Expand Down
108 changes: 107 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,107 @@
# music-editor
# Music Editor

<div align="center">

[![Release](https://img.shields.io/github/release/theodorechu/music-editor.svg)](https://github.com/theodorechu/music-editor/releases)
[![License](https://img.shields.io/github/license/theodorechu/music-editor?color=blue)](https://github.com/theodorechu/music-editor/blob/main/LICENSE)
[![Status](https://img.shields.io/badge/status-open%20beta-orange.svg)](https://musiceditor.net/#installation)
[![Cost](https://img.shields.io/badge/cost-free-darkgreen.svg)](https://musiceditor.net/#installation)
[![GitHub issues](https://img.shields.io/github/issues/theodorechu/music-editor.svg)](https://github.com/theodorechu/music-editor/issues/)
[![Slack](https://img.shields.io/badge/slack-standardnotes-CC2B5E.svg?style=flat&logo=slack)](https://standardnotes.org/slack)
[![Downloads](https://img.shields.io/github/downloads/theodorechu/music-editor/total.svg?style=flat)](https://github.com/theodorechu/music-editor/releases)
[![GitHub Stars](https://img.shields.io/github/stars/theodorechu/music-editor?style=social)](https://github.com/theodorechu/music-editor)

</div>

## Introduction

The Music Editor is an **unofficial** [editor](https://standardnotes.org/help/77/what-are-editors) for [Standard Notes](https://standardnotes.org), a free, [open-source](https://standardnotes.org/knowledge/5/what-is-free-and-open-source-software), and [end-to-end encrypted](https://standardnotes.org/knowledge/2/what-is-end-to-end-encryption) notes app.

You can find the demo at [demo.musiceditor.net](https://demo.musiceditor.net).

The Music Editor is powered by [VexTab](https://github.com/0xfe/vextab) and [VexFlow](https://github.com/0xfe/vexflow). A tutorial on how to use VexTab is available [here](https://vexflow.com/vextab/tutorial.html).

## Installation

1. Register for an account at Standard Notes using the [Desktop App](https://standardnotes.org/download) or [Web app](https://app.standardnotes.org). Remember to use a strong and memorable password.
2. In the bottom left corner of the app, click **Extensions**.
3. Click **Import Extension**.
4. Paste this into the input box:
```
https://notes.theochu.com/p/Sfq1jJV0X2
```
or paste this into the input box on **desktop**:
```
https://raw.githubusercontent.com/TheodoreChu/music-editor/main/public/demo.ext.json
```
5. Press Enter or Return on your keyboard.
6. Click **Install**.
7. At the top of your note, click **Editor**, then click **Music Editor**.
8. 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](https://standardnotes.org/download) after you sign in.

## Development

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

### Available Scripts

In the project directory, you can run:

#### `yarn start`

Runs the app in the development mode.<br />
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.<br />
You will also see any lint errors in the console.

#### `yarn test`

Launches the test runner in the interactive watch mode.<br />
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

#### `yarn build`

Builds the app for production to the `build` folder.<br />
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.<br />
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/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](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).

## License

Copyright (c) Theodore Chu. All Rights Reserved. Licensed under [AGPL-3.0](https://github.com/TheodoreChu/music-editor/blob/main/LICENSE) or later.

## Acknowledgements

Early stages of this editor were based heavily on the Standard Notes [Markdown Basic Editor](https://github.com/standardnotes/markdown-basic). The Markdown Basic Editor is licensed under AGPL-3.0 and is available for use through [Standard Notes Extended](https://standardnotes.org/extensions).

## Further Resources

- [GitHub](https://github.com/TheodoreChu/music-editor) for the source code of the Music Editor
- [GitHub Issues](https://github.com/TheodoreChu/music-editor/issues) for reporting issues concerning the Music Editor
- [Docs](https://docs.theochu.com/music-editor) for how to use the Music Editor
- [Contact](https://theochu.com/contact) for how to contact the developer of the Music Editor
- [Music Editor To do List](https://github.com/TheodoreChu/music-editor/projects/1) for the roadmap of the Music Editor
- [Standard Notes Slack](https://standardnotes.org/slack) for connecting with the Standard Notes Community
- [Standard Notes Help](https://standardnotes.org/help) for help with issues related to Standard Notes but unrelated to this editor
1 change: 1 addition & 0 deletions build/CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
demo.musiceditor.net
Loading

0 comments on commit a597979

Please sign in to comment.