Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

What to do after install? #26

Open
2dned opened this issue Jun 2, 2023 · 6 comments
Open

What to do after install? #26

2dned opened this issue Jun 2, 2023 · 6 comments

Comments

@2dned
Copy link

2dned commented Jun 2, 2023

Hi guys, i think i have installed everything now but not sure what to do next.
Do i make an index.html and add some script to it or?

@tombatossals
Copy link
Owner

Hi, chords-db is just the database of chords, to render it you can create your own render, or use this one:

https://github.com/tombatossals/react-chords

@2dned
Copy link
Author

2dned commented Jun 2, 2023

Hi Thank you for reply.
I have installed react-chords now.
With the usage code, what do i save it as? .php or .js or html
So how do i render the page?

@2dned
Copy link
Author

2dned commented Jun 3, 2023

ok worked out it needs to be a .js file, lets call it index.js
now what? lol

@tombatossals
Copy link
Owner

You need to use React for using this directive. Everything is generated client-side, but you could generate png's if you need it. Take a look at the "webpage" branch, it's the Gatsby implementation of the main page with all the cords.

Gatsby Project Source code: https://github.com/tombatossals/chords-db/tree/webpage

Result page: https://tombatossals.github.io/react-chords/

Cheers

@2dned
Copy link
Author

2dned commented Jun 3, 2023

Well after 20 hrs of stuffing around i give up, will find another source code with some form of install or instructions.

As a polite note, you should add some documentation on how to install it not just add command here throw some script somewhere unspecified or name of file.

I do thank you for the time and effort you have put into it.

@enfff
Copy link

enfff commented Jul 24, 2024

mkdir myroot && cd myroot
git clone https://github.com/tombatossals/chords-db/
cd chords-db && sudo npm link
cd .. && sudo npm link @tombatossals/chords-db 

ignore the warnings

now your the database is locally installed, you can check that with npm list | grep chords

at this point just start writing your program, let's say bored.js

from there on, you can access the database with

const ukulele = require(`@tombatossals/chords-db/lib/ukulele.json`)
or
const guitar = require(`@tombatossals/chords-db/lib/guitar.json`)

have fun

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants