Giter Site home page Giter Site logo

wpspin's Introduction

WPSpin

A WordPress plugin providing integration with Spinitron's SpinPAPI API service.

Requirements

  • WordPress version 3.5 or higher (may work on lower versions, not tested).
  • PHP version 5.3 or higher.
  • Spinitron API access. You will need your API Key and shared secret when installing this plugin. If you do not have this and need access, contact Spinitron.

Installing

  • Clone or copy project folder into wp-content/plugins directory
  • Install the SpinPapi PHP client by running the commands git submodule init and git submodule update in the WPSpin root directory
  • Ensure that the WPSpin/spinpapi/tmp folder is writable by the web server user
  • Activate plugin from WordPress plugins screen
  • Click 'Spinitron' in WordPress menu
  • Fill in user id, secret key, and station callsign. Be sure to check 'Import Show & DJ Data' to load your station's information from Spinitron.

Features

"Now on Air" Content

To insert a block of content with information about the show currently on air, simply insert the shortcode [wpspin-now-playing] into the page where you'd like the block to appear.

Program Schedule

To render a weekly program schedule, use the shortcode [wpspin-show-schedule]. If you'd like to customize the appearance from the default Spinitron style, the stylesheet that controls the layout for this view is located in views/showschedule.css.

Playlist Widget

WPSpin provides a widget that displays the ten most recent items on the current playlist in reverse-chronological order.

DJ Profiles

DJ Profiles are implemented as custom post types and can be edited to add photos and descriptions. If you are using 'post name' style permalinks, a listing of all DJs can be accessed at /wpspin_profiles (e.g. www.mysite.com/wordpress/wpspin_profiles).

Show Listings

Show listings are implemented as custom post types and can be edited to add photos and descriptions. If you are using 'post name' style permalinks,A listing of all shows can be accessed at /wpspin_shows (e.g. www.mysite.com/wordpress/wpspin_shows).

Theming and Styles

Both the playlist widget and the "Now on Air" content can be styled to fit with your site's wordpress theme. HTML element types and their respective classes are listed below.

Should you wish to edit the view templates, they can be found in /views/.

"Now on Air"

div wps-now-playing

  • img wps-nowplaying-show-image
  • h3 wps-nowplaying-title
  • span wps-nowplaying-desc
  • div wps-nowplaying-profile
  • img wps-nowplaying-profile-image
  • span wps-nowplaying-profile-name
  • span wps-nowplaying-profile-bio
  • span wps-nowplaying-profile-facebook
  • span wps-nowplaying-profile-twitter

Playlist

wps-playlist-template

  • p track
  • p artist
  • p timestamp

wpspin's People

Contributors

mtomcal avatar gastonfig avatar

Watchers

 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.