Giter Site home page Giter Site logo

rruy / openchord Goto Github PK

View Code? Open in Web Editor NEW

This project forked from artutra/openchord

0.0 0.0 0.0 2.38 MB

A React Native songbook app for guitar players

License: GNU General Public License v3.0

JavaScript 0.54% Ruby 1.27% Objective-C 2.41% Java 1.30% TypeScript 92.21% Dockerfile 1.15% Starlark 1.11%

openchord's Introduction

Open Chord Icon

OpenChord

Cross-platform chordpro reader app for Android and iOS written with React Native.

Build Status PRs Welcome License: GPL v3 David Discord

๐Ÿ“ท Screenshots

screenshot-1 screenshot-2 screenshot-3 screenshot-4 screenshot-5

๐Ÿš€ Features

Open Chord is a React Native application for both Android and iOS that allows you to organize your chord charts, lyric sheets and songbooks with a simple app on your tablet or smartphone. Open Chord easily allows you to get rid of all that paper by displaying your music in a flexible, easy to read format.

To perform searches and download the songs the app uses OpenChordApi. OpenChordApi is currently BETA, which means it may be unreliable, unavailable or not working. That said, it's already useful and we're working to make it rock solid.

Join the community: Discord Chat

A few features include:

Feature Support
Render song with chordpro format โœ”๏ธ
Import songs from the web โœ”๏ธ
Transpose song โœ”๏ธ
Create/edit song โœ”๏ธ
Show/hide tabs โœ”๏ธ
Configure font size โœ”๏ธ
Show guitar chord diagrams โœ”๏ธ
Autoscroll โœ”๏ธ
Manage playlists โœ”๏ธ
Search saved songs โœ”๏ธ
Slide with touch ๐Ÿ•‘
Slide with volume button ๐Ÿ•‘
Multiple columns visualization ๐Ÿ•‘
Multiple languages support ๐Ÿ•‘
Chord dictionary ๐Ÿ•‘
Playlist presentation mode ๐Ÿ•‘

โœ”๏ธ = supported

๐Ÿ•‘ = will be supported in a future version

โœ–๏ธ = currently no plans to support it in the near future

๐Ÿ”จ Try it yourself

1. Clone and Install

# clone the repo
git clone https://github.com/artutra/OpenChord.git

# Open the folder and install dependencies
cd OpenChord && npm install

2. Run it on both iOS and Android

# Run on iOS
npm run build:ios

# Run on Android
npm run build:android

Or use Docker (for Android)

# Build the container and run the build scripts inside it
docker-compose run --service-ports android bash

Obs: The docker container can't attatch to the device via USB. You have to build the app-debug.apk using npm run build:android, copy the generated file inside ./android/app/build/outputs/apk/debug/app-debug.apk and install it manually on the device.

Built With

  • React Native v0.60 - The framework for building native apps using React
  • Realm v3.0 - Realm is a mobile database that runs directly inside phones, tablets or wearables
  • React Navigation v4.0 - React Native module support navigation
  • React Native Vector Icons v6.6 - Customizable Icons for React Native with support for NavBar/TabBar/ToolbarAndroid, image source and full styling
  • React Native Webview - A modern, well-supported, and cross-platform WebView for React Native
  • ChordSheetJS - A JavaScript library for parsing and formatting chord sheets
  • ChordPro - A text file format to write lead sheets, songs with lyrics and chords

๐Ÿ™‹ How can you help

If you find any problems, feature requests, please open an issue or submit a fix as a pull request.

๐Ÿ“ฐ License

GNU General Public License v3.0

โญ Credits

Made with โค๏ธ by Artur Miranda

openchord's People

Contributors

artutra avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.