|
1 | | -# shoutcast-ionic-tutorial |
| 1 | +# Shoutcast Ionic Tutorial |
| 2 | +This project is the source code of a tutorial on how to build an Ionic/Phonegap Radio Player and display Song title, Cover art and any other information which is provided by the SHOUTcast stream server. |
| 3 | + |
| 4 | +## Where to find the tutorial |
| 5 | +The complete tutorial is published on [Medium](https://medium.com/titanium-templates/display-song-title-and-cover-by-utilizing-shoutcast-s-meta-data-fb00011cb086). |
| 6 | + |
| 7 | +## Dependecies, Run and Build |
| 8 | +### Install NodeJS dependencies |
| 9 | + |
| 10 | +Run `npm install` to install all needed dependencies |
| 11 | + |
| 12 | +### Install Javascript dependencies |
| 13 | + |
| 14 | +Run `bower install` to install all needed dependencies. |
| 15 | + |
| 16 | +### Run the app |
| 17 | +Use `grunt serve -l` to run the app in browser and watch for changes in code |
| 18 | + |
| 19 | +or |
| 20 | + |
| 21 | +use `grunt serve` to just run the app for a browser preview |
| 22 | + |
| 23 | +or |
| 24 | + |
| 25 | +use `grunt serve --lab` to run the app in a browser on two platforms at the same time. |
| 26 | + |
| 27 | +### Add a platform |
| 28 | + |
| 29 | +```bash |
| 30 | +$ grunt platform:add:<platform> |
| 31 | +``` |
| 32 | + |
| 33 | +Supported Cordova platforms: |
| 34 | + |
| 35 | +```bash |
| 36 | +$ grunt platform:add:ios |
| 37 | +$ grunt platform:add:android |
| 38 | +``` |
| 39 | + |
| 40 | +### Build the app |
| 41 | + |
| 42 | +```bash |
| 43 | +$ grunt build |
| 44 | +``` |
| 45 | + |
| 46 | +### Emulate the app on simulator |
| 47 | +iOS: |
| 48 | + |
| 49 | +```bash |
| 50 | +$ grunt emulate:ios |
| 51 | +``` |
| 52 | + |
| 53 | +Android: |
| 54 | + |
| 55 | +```bash |
| 56 | +$ grunt emulate:android |
| 57 | +``` |
| 58 | + |
| 59 | +For more information, see [Ionic Framework Generator's instructions](https://github.com/diegonetto/generator-ionic). |
| 60 | + |
| 61 | +### Plugins installation |
| 62 | + |
| 63 | +Use the following commands and install the plugin required by the app: |
| 64 | +```bash |
| 65 | +$ cordova plugin add com.keosu.cordova.stream |
| 66 | +``` |
| 67 | +or |
| 68 | +```bash |
| 69 | +$ cordova plugin add https://github.com/keosuofficial/cordova-audio-stream-plugin.git |
| 70 | +``` |
| 71 | + |
| 72 | +#### Used Cordova plugins |
| 73 | +In case that the required Cordova plugins are not installed while installing NodeJS dependencies, Cordova's command mentioned previously can be used to install the following plugins: |
| 74 | + |
| 75 | +* **com.keosu.cordova.stream** - Provides a web browser view. It could be used to open images, access web pages, and open PDF files (https://github.com/keosuofficial/cordova-audio-stream-plugin.git). |
| 76 | + |
| 77 | +## Further information and help |
| 78 | +A production ready [Music Band Ionic](http://codecanyon.net/item/music-band-ionic-full-application/12044328?ref=skounis) application which demonstrates and extends everything that is described in this tutorial is available in [Codecanyon](http://codecanyon.net/item/music-band-ionic-full-application/12044328?ref=skounis). [Music Band Ionic](http://codecanyon.net/item/music-band-ionic-full-application/12044328?ref=skounis) application offers a a wide range of features, that will fit the requirements of every music band — artist, amongst them a player which makes use of SHOUTcast metadata. |
| 79 | + |
| 80 | +## Third Party Licences |
| 81 | +* [Apache License](http://www.apache.org/licenses/) |
| 82 | +* [MIT License](https://opensource.org/licenses/MIT) |
0 commit comments