Chordion

🎵 An easy reference for chord construction 🎵

View the Website

Table of Contents

• Description
• Tech Stack
• Folder Structure
• Run Locally
• Contributing
• License

Description

Chordion is a handy reference for chord construction. It can be your companion in practicing, playing a musical instrument, or making music. You can see the chord formula with the notes that make up the chord. You can also listen to the sound of the chord.

Choose a start note/ root note, octave, and chord type, then you can see the chord formula with the chord notes. When you select a chord type, you will also hear how the chord sounds.

Tech Stack

• Language: JavaScript
• Frontend Library: React 18
• State Management: React Context-Provider Pattern
• Frontend Build Tool: Vite
• CSS Framework: Tailwind CSS 3
• Music Theory Library: tonal
• Audio Library: howler.js
• Linter: ESLint
• Code Formatter: Prettier
• Git Hook: Husky

Folder Structure

.
├── public
├── src
│   ├── assets
│   ├── components
│   ├── context
│   ├── data
│   ├── hooks
|   ├── layouts
│   ├── utils
│   ├── App.jsx
│   ├── index.css
│   └── main.jsx
├── ...
├── index.html
├── ...
├── package.json
├── ...
├── README.md
├── tailwind.config.cjs
├── ...
.

Run Locally

Getting Started

• Make sure you have Node.js and Yarn installed on your computer.

• Clone the repo.

  git clone https://github.com/nadiannis/chordion.git
  cd chordion

• Install the dependencies.

  yarn

Development

Run the development server.

yarn dev

Production

Build the app.

yarn build

Contributing

You can contribute to this project by creating an issue or pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.