Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ts5h/chord_explorer
A playable chord explorer
https://github.com/ts5h/chord_explorer
react react-typescript reactjs tone tonejs typescript
Last synced: 6 days ago
JSON representation
A playable chord explorer
- Host: GitHub
- URL: https://github.com/ts5h/chord_explorer
- Owner: ts5h
- License: mit
- Created: 2023-10-25T22:37:06.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-02-20T23:39:29.000Z (9 months ago)
- Last Synced: 2024-02-21T01:00:34.429Z (9 months ago)
- Topics: react, react-typescript, reactjs, tone, tonejs, typescript
- Language: TypeScript
- Homepage:
- Size: 11.2 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Chord Explorer
A playable chords visualizer and reference for keyboards.
I made it for myself, not being familiar with chords and to learn them.
Live Demo:
https://ts5h.github.io/chord_explorer/
### Packages
- create-react-app
- Typescript
- Chakra UI
- Sass (dart-sass)
- Biome (Formatter) *1
- ESLint *2
*1 See `./biome.json`
*2 See `./.eslintrc`
## References
- Chord formulas
https://www.smithfowler.org/music/Chord_Formulas.htm
- pianochord.org
https://pianochord.org/
- ChatGPT
https://chat.openai.com/
## Basic Usage
### Install & Run
```shell
$ git clone [email protected]:ts5h/react-minimum-boilerplate.git your_project
$ pnpm install
$ pnpm start
```
### ESLint with fix
```shell
$ pnpm lint:fix
```
### Prettier formatting
```shell
$ pnpm format
```
Customize and extend as you like.
# Getting Started with Create React App
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Available Scripts
In the project directory, you can run:
### `pnpm start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.\
You will also see any lint errors in the console.
### `pnpm test`
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `pnpm build`
Builds the app for production to the `build` folder.\
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.\
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `pnpm 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/).
## Update Packages
I recommend using `npm-check-updates` package.
https://github.com/raineorshine/npm-check-updates
```shell
$ ncu
$ ncu -u
$ pnpm install
```