first commit

cmhh · Aug 22, 2022 · 168e60d · 168e60d
commit 168e60d
Show file tree

Hide file tree

Showing 15 changed files with 1,793 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,31 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+.DS_Store
+dist
+dist-ssr
+coverage
+*.local
+
+/cypress/videos/
+/cypress/screenshots/
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+test.html
+public
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,3 @@
+{
+  "recommendations": ["Vue.volar", "Vue.vscode-typescript-vue-plugin"]
+}
diff --git a/README.md b/README.md
@@ -0,0 +1,60 @@
+# chordvuer
+
+Display guitar chords, with animated transitions between chords.
+
+![](img/chordvuer.webp)
+
+## Project Setup
+
+```sh
+npm install
+```
+
+### Compile and Hot-Reload for Development
+
+```sh
+npm run dev
+```
+
+### Compile and Minify for Production
+
+```sh
+npm run build
+```
+
+## Basic Usage
+
+```html
+<html>
+<head>
+
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/vue/3.2.36/vue.global.prod.min.js"></script>
+  <script src="dist/chordvuer.umd.js"></script>
+  <link rel="stylesheet" href="./dist/style.css">
+
+  <style>
+    .chord {
+      height: 543px; 
+      width:  400px; 
+    }
+  </style>
+</head>
+<body>
+  <div id="app">
+    <chord 
+      id="chord1"
+      :chord='chords.Gmaj'
+    ></chord>
+  </div>
+
+  <script>
+    const app = Vue.createApp({})
+    app.config.globalProperties.chords = window.chordvuer.chords;
+    app.component('chord', chordvuer.Chord)
+    app.mount('#app')
+  </script>
+</body>
+</html>
+```
+
+![](img/gmaj.png)
diff --git a/img/chordvuer.webp b/img/chordvuer.webp
diff --git a/img/gmaj.png b/img/gmaj.png
diff --git a/index.html b/index.html
@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" href="/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>ChordVuer</title>
+    <style>
+      #chord1, #chord2, #chord3 {
+        height: 543px;
+        width:  400px;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.js"></script>
+  </body>
+</html>