https://github.com/l3ku/ultimate-guitar-tabs-chords
DEPRECATED: A WordPress plugin that fetches tabs and chords from Ultimate Guitar
https://github.com/l3ku/ultimate-guitar-tabs-chords
guitar-chords guitar-tabs ultimate-guitar unit-tests
Last synced: 4 months ago
JSON representation
DEPRECATED: A WordPress plugin that fetches tabs and chords from Ultimate Guitar
- Host: GitHub
- URL: https://github.com/l3ku/ultimate-guitar-tabs-chords
- Owner: l3ku
- License: lgpl-3.0
- Created: 2017-10-09T16:44:31.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-11T18:34:59.000Z (over 6 years ago)
- Last Synced: 2024-11-24T09:42:37.481Z (5 months ago)
- Topics: guitar-chords, guitar-tabs, ultimate-guitar, unit-tests
- Language: PHP
- Homepage:
- Size: 255 KB
- Stars: 5
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ultimate Guitar Tabs & Chords
[](https://travis-ci.org/l3ku/ultimate-guitar-tabs-chords)
[](https://packagist.org/packages/l3ku/ultimate-guitar-tabs-chords)
[](https://packagist.org/packages/l3ku/ultimate-guitar-tabs-chords)
[](https://packagist.org/packages/l3ku/ultimate-guitar-tabs-chords)
A WordPress plugin that fetches tabs and chords from Ultimate Guitar by scraping HTML.
## Installation
This plugin is yet not available via the wordpress.org plugins directory. Installation is done by navigating to the WordPress plugins directory and cloning the plugin git repository by cloning this project from GitHub:
```git clone [email protected]:l3ku/ultimate-guitar-tabs-chords.git```.
If Composer is used in your project, this plugin can also be included by running `composer require l3ku/ultimate-guitar-tabs-chords`.
The plugin should now be available for activation in the WordPress admin plugins page. After activation, a new settings page (under "Settings") should be available with the name `UG Tabs & Chords`.
## Usage
Add the plugin shortcode to the desired page or post. You can generate the plugin shortcode by using the shortcode generator available on the plugin settings page.
## Tests
PHPUnit based unit tests are included in this project in the `tests/` directory. Before running the tests, install the WordPress test suite by running the installation script in the plugin directory:
```bash bin/install-wp-tests.sh wordpress_test localhost latest```
NOTE: *the database user needs permissions to create tables*
The tests can then be run by simply running the command `phpunit`.
## Development
This project is very new and the features of this plugin are still quite limited. Feedback, issues and PR:s are welcome! However, before submitting a pull request make sure that:
1. All tests complete successfully
2. The commits in your PR are logical entities (use `git rebase -i` if necessary)
3. Your code is in line with [WordPress plugin guidelines](https://developer.wordpress.org/plugins/wordpress-org/detailed-plugin-guidelines/), [WordPress coding standards](https://make.wordpress.org/core/handbook/best-practices/coding-standards/php/#naming-conventions) and
the already existing plugin code
4. You clearly explain in the PR what is done and why