Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/richiepowell/tin-whistle-tabs-generator
Generate tin whistle tabs from the musical alphabet. Uses NextJS, ChakraUI, and TypeScript.
https://github.com/richiepowell/tin-whistle-tabs-generator
Last synced: 2 days ago
JSON representation
Generate tin whistle tabs from the musical alphabet. Uses NextJS, ChakraUI, and TypeScript.
- Host: GitHub
- URL: https://github.com/richiepowell/tin-whistle-tabs-generator
- Owner: RichiePowell
- Created: 2021-08-10T01:03:07.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-27T14:50:40.000Z (8 months ago)
- Last Synced: 2024-03-28T08:54:00.946Z (8 months ago)
- Language: TypeScript
- Homepage: https://tinwhistletabscreator.vercel.app
- Size: 184 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Tin Whistle Tabs Generator
A Next.js-based tool for generating tin whistle tabs quickly and easily, with a customizable interface using ChakraUI. This generator allows you to input musical notes and instantly visualize the corresponding tin whistle tabs.
## Features
- **Preset Tabs**: Choose from several built-in tabs to get started quickly.
- **Custom Tabs**: Input your own musical alphabet notes to generate custom tabs.
- **Save to Local Storage**: Save your custom tabs locally for future reference.
- **Responsive Design**: The interface is designed using ChakraUI for a clean and responsive user experience.
## Tech Stack
- **Next.js**: The React framework used to build the app.
- **ChakraUI**: Provides the UI components for a customizable and responsive interface.
- **Local Storage**: Saves user-generated tabs locally for future use.
## Installation
To get started with the project locally, follow these steps:
1. **Clone the repository:**
```bash
git clone https://github.com/RichiePowell/tin-whistle-tabs-generator.git
```
2. **Navigate to the project directory:**
```bash
cd tin-whistle-tabs-generator
```
3. **Install the dependencies:**
```bash
npm install
```
4. **Run the development server:**
```bash
npm run dev
```
5. Open [http://localhost:3000](http://localhost:3000) in your browser to see the app.
## Usage
1. **Preset Tabs**: Select one of the preset tabs to get started quickly.
2. **Create Custom Tabs**: Type or paste musical notes using the musical alphabet (A, B, C, etc.), and the generator will create tabs based on your input.
3. **Save Tabs**: Once you are happy with your tabs, save them to local storage for future use by clicking the 'Save' button.
4. **Load Saved Tabs**: Reload your previously saved tabs directly from local storage.
## Contributing
If you would like to contribute to this project, feel free to fork the repository and submit a pull request. All contributions are welcome!
## Roadmap
- **More Customization Options**: Add more features like different styles of notation and tunings.
- **Shareable Tabs**: Allow users to export and share their tabs.
- **Mobile-Friendly Enhancements**: Further optimize the interface for mobile users.
## License
This project is licensed under the MIT License.