https://github.com/zcaceres/revelry
:loudspeaker: Turn your sound files into an Express Server
https://github.com/zcaceres/revelry
Last synced: 28 days ago
JSON representation
:loudspeaker: Turn your sound files into an Express Server
- Host: GitHub
- URL: https://github.com/zcaceres/revelry
- Owner: zcaceres
- Created: 2018-04-22T22:34:46.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-26T12:56:01.000Z (about 8 years ago)
- Last Synced: 2025-11-29T09:43:19.420Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 4.1 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# :loudspeaker: Revelry :loudspeaker:
### Automatic API for your Sound Files
[Inspired by Gilfoyle's Napalm Death Bitcoin alert...](https://www.youtube.com/watch?v=ybGOT4d2Hs8) :metal:
Revelry is a simple app that wraps your sound files with a REST-style API. You can then call the API to play sounds. Revelry assumes your server has a speaker (i.e. your server is a wifi-enabled Arduino or your old laptop!).
Use cases include:
1. An audio notification system for webhooks :alarm_clock:
2. Trolling your friends with a hidden speaker that you control with your cell phone :smiling_imp:
3. A Jukebox controlled by raw HTTP requests :musical_note:
The REST api mirrors the file structure of your /sounds directory. Some sample sounds are included (Unreal Tournament, George Michael, Eye of the Tiger...)
> PRs and additional sounds welcome!
### To Use
1. Clone repo
2. ```npm i```
3. ```nvm use``` (Or manually switch to Node 8.9);
4. Drop sounds into subdirectories of the `sounds` folder. You can create any directories you want, but Revelry currently supports only one layer deep.
3. ```npm start``` to launch
4. Send requests to ```localhost:3000/subdirectory-name-here/filename-here```
5. Explore sound options from ```localhost:3000```
### How to Easily Make Your Server Public
Download and set up `ngrok`.
From inside your Revelry project folder...
```
npm start
ngrok http 3000
```
You're live! :clap: