https://github.com/paulrosen/abcjs-configurator
Understanding the options that are passed to abcjs
https://github.com/paulrosen/abcjs-configurator
abcjs music-notation music-player
Last synced: 2 months ago
JSON representation
Understanding the options that are passed to abcjs
- Host: GitHub
- URL: https://github.com/paulrosen/abcjs-configurator
- Owner: paulrosen
- Created: 2018-01-14T16:07:58.000Z (over 7 years ago)
- Default Branch: development
- Last Pushed: 2023-01-03T21:44:15.000Z (over 2 years ago)
- Last Synced: 2024-12-25T20:11:55.576Z (4 months ago)
- Topics: abcjs, music-notation, music-player
- Language: Vue
- Size: 2.32 MB
- Stars: 10
- Watchers: 4
- Forks: 1
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# abcjs-configurator
> Understanding the options that are passed to abcjs
This app contains every option that can be used in [abcjs](https://abcjs.net) and allows the user to easily play with each option.
This app is deployed to [Configurator](https://configurator.abcjs.net) so you don't have to clone the project to get the benefit of it.
## This Project's Creation
The initial generation of this project was done with:
``` bash
npx create-nuxt-app abcjs-configurator
npx: installed 318 in 9.43s
> Generating Nuxt.js project in /path/to/project/abcjs-configurator
? Project name abcjs-configurator
? Project description Understanding the options that are passed to abcjs
? Use a custom server framework none
? Use a custom UI framework vuetify
? Choose rendering mode Universal
? Use axios module yes
? Use eslint yes
? Use prettier no
? Author name Paul Rosen
? Choose a package manager npm
```
## To develop
Start the server with:
``` bash
npm run dev
```
The page is at `localhost:3000`.
## To deploy
Static pages are generated into the `/dist` folder, then those files are copied to the server. There is a bash script for that called `deploy-to-production.sh` that does this:
``` bash
./deploy-to-production.sh
```
It requires the file `deploy-constants.sh`. You can see the format that this file should have by copying the file `deploy-contants-example.sh`.
## Build Setup
(These are the initial instructions that were generated with the example app.)
``` bash
# install dependencies
$ npm install
# serve with hot reload at localhost:3000
$ npm run dev
# build for production and launch server
$ npm run build
$ npm start
# generate static project
$ npm run generate
```
For detailed explanation on how things work, checkout [Nuxt.js docs](https://nuxtjs.org).