Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
paulrosen committed Nov 6, 2022
1 parent 9447763 commit 03d6483
Show file tree
Hide file tree
Showing 63 changed files with 33,913 additions and 2 deletions.
21 changes: 21 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
module.exports = {
root: true,
env: {
browser: true,
node: true
},
parserOptions: {
parser: 'babel-eslint'
},
extends: [
//'@nuxtjs',
//'plugin:nuxt/recommended'
'plugin:vue/essential',
],
// required to lint *.vue files
plugins: [
'vue'
],
// add your custom rules here
rules: {}
}
91 changes: 91 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# Created by .ignore support plugin (hsz.mobi)
### Node template
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# nyc test coverage
.nyc_output

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# TypeScript v1 declaration files
typings/

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env

# parcel-bundler cache (https://parceljs.org/)
.cache

# next.js build output
.next

# nuxt.js build output
.nuxt

# Nuxt generate
dist

# vuepress build output
.vuepress/dist

# Serverless directories
.serverless

# IDE / Editor
.idea
.editorconfig

# Service worker
sw.*

# Mac OSX
.DS_Store

# test soundfont
static/soundfont-*
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
9 changes: 9 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
FROM node:16.10.0

RUN npm install -g [email protected]

RUN mkdir /srv/app && chown node:node /srv/app

USER node

WORKDIR /srv/app
2 changes: 1 addition & 1 deletion LICENSE → LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2022 abcjs
Copyright (c) 2022 Paul Rosen

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
60 changes: 59 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,60 @@
![abcjs](https://paulrosen.github.io/abcjs/img/abcjs_comp_extended_08.svg)
# abcjs-editor
Simple visual editing of ABC strings

> Simple visual editing of ABC strings
For info on the underlying library, please go to [abcjs](https://github.com/paulrosen/abcjs).

## Deploy
To deploy, just merge the code you want to deploy to production - Netlify does the rest. The following script will do it if you've checked in all your changes:
```
./deploy.sh
```

## Docker
To run under Docker on your local machine, create an environment variable `$abcjs_editor_web` with the port you'd like to run on (possibly by adding the following to your system profile: `export abcjs_editor_web=3001`)

The first time, do `./docker-build.sh`. Then to start, do `./docker-start.sh` and you will be in a shell to run the `npm` commands.

## Contributing
Contributions and issues are welcome. Create a pull request to the `main` branch.

Before contributing a new feature please create an issue so we can discuss - it might be something I'm working on already or it might be something that would conflict with something I'm working on.

This is intended to be a simple app for quick editing. A few additional pieces of functionality are welcome, but if you are looking for a full-fledged music editor, feel free to fork this and just use it as a starting place.

If you come up with something cool and it is fairly generic and either shows off abcjs or is a useful tool for using abcjs, please consider hosting it in this organization. Contact me for details.

## Creation
```bash
$ npx create-nuxt-app abcjs-editor
? Project name abcjs-editor
? Project description Simple visual editing of ABC strings
? Author name Paul Rosen
? Choose the package manager Npm
? Choose UI framework None
? Choose custom server framework None (Recommended)
? Choose Nuxt.js modules Progressive Web App (PWA) Support
? Choose linting tools ESLint
? Choose test framework None
? Choose rendering mode Universal (SSR)
```

## Build Setup

``` bash
# install dependencies
$ npm run install

# serve with hot reload at localhost:3000
$ npm run dev

# build for production and launch server
$ npm run build
$ npm run start

# generate static project
$ npm run generate
```

For detailed explanation on how things work, check out [Nuxt.js docs](https://nuxtjs.org).
3 changes: 3 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Version 1.0.0

Initial commit
9 changes: 9 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Security Policy

## Supported Versions

Only the latest version will get security updates. Please stay updated if possible.

## Reporting a Vulnerability

Contact Paul Rosen directly if you detect a security problem. The most reliable way is to through the contact form on https://abcjs.net.
7 changes: 7 additions & 0 deletions assets/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# ASSETS

**This directory is not required, you can delete it if you don't want to use it.**

This directory contains your un-compiled assets such as LESS, SASS, or JavaScript.

More information about the usage of this directory in [the documentation](https://nuxtjs.org/guide/assets#webpacked).
51 changes: 51 additions & 0 deletions components/AbcjsOutput.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<template>
<section :class="`abcjs-output ${shorten ? 'short' :''}`" :tabindex="shorten ? '0' : null">
<div id="canvas"></div>
</section>
</template>

<script>
import ButtonWithIcon from "./ButtonWithIcon";
export default {
name: "abcjs-output",
components: {ButtonWithIcon},
props: {
shorten: {
type: Boolean,
required: false,
default: false
}
},
data() {
return {
}
},
}
</script>

<style scoped>
.abcjs-output {
position: relative;
max-width: 900px;
background-color: #F3ECe2;
box-shadow: 2px 2px 4px #bbbbbb, -1px -1px 1px #bbbbbb;
}
nav {
text-align: right;
padding-right: 10px;
}
.short {
height: 290px;
overflow: auto;
}
</style>

<style>
@media print {
[fill="#ff0000"] {
fill: currentColor;
}
}
</style>
Loading

0 comments on commit 03d6483

Please sign in to comment.