https://github.com/w4/zpan
:musical_note: Radio DJ management panel with vBulletin integration, book time in to DJ, host events and take requests from your listeners.
https://github.com/w4/zpan
control-panel radio shoutcast
Last synced: 7 months ago
JSON representation
:musical_note: Radio DJ management panel with vBulletin integration, book time in to DJ, host events and take requests from your listeners.
- Host: GitHub
- URL: https://github.com/w4/zpan
- Owner: w4
- Created: 2016-06-18T11:55:53.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-11-12T09:22:41.000Z (almost 8 years ago)
- Last Synced: 2025-01-03T12:22:31.366Z (9 months ago)
- Topics: control-panel, radio, shoutcast
- Language: PHP
- Homepage:
- Size: 115 KB
- Stars: 1
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# zpan
Zpan is a beautiful radio management control panel written using Laravel. It has the following features:
- "Connection Info" page for DJs
- Request line
- Bans by IP
- Radio timetable (by user's timezone)
- Events
- Events require approval from a manager (or admin)
- vBulletin integration (you need a vBulletin users database to authenticate users from - shows the user's display name globally)
## API Endpoints
### GET /api/dj-says
Response:
```json
{
"dj": "
Jordan Doyle",
"msg": "Welcome to the radio!"
}
```
### GET /api/timetable
Response:
```json
[
{
"name": "Monday",
"0": null,
"1": null,
"2": null,
...
"13": "
Jordan Doyle",
"14": "Jordan Doyle",
"15": null
...
},
{
"name": "Tuesday",
"0": null,
"1": null,
...
"10": "10am Tuesdays",
"11": null,
...
}
]
```
### GET /api/event/all
Response:
```json
[
{
"name": "Monday",
"0": null,
"1": null,
"2": null,
...
"13": "
The 1pm Event",
"15": null
},
...
]
```
### GET /api/event/current
Response:
```json
{
"id": 10,
"name": "
Jordan Doyle",
"type": "Falling Furni",
"room": 123456789,
"booked": true
}
```
OR
```json
{
"booked": false
}
```
### GET /api/stats
Response:
```json
{
"listeners": 32,
"raw_dj": "Jordan",
"dj": "Jordan",
"habbo": "jordanpotter",
"artist": "Aystar",
"song": "Behind Barz Freestyle"
}
```
OR
```json
{
"status": false
}
```
### POST /api/request
Request:
```json
{
"name": "Dave The Requester",
"request": "Hey can you play Cotton Eyed Joe please?"
}
```
Response:
```json
{
"type": "success",
"msg": "Successfully submitted your request. We'll let the DJ know!"
}
```
### Installation
You must configure the [groups](https://github.com/w4/zpan/blob/master/app/Models/Group.php) to match your vBulletin setup. Then copy `.env.example` to `.env` and configure.
You can then run the migrations and gulp and you're ready to go!
```bash
php artisan migrate
gulp
```