Skip to content

Commit aaf7a62

Browse files
captbaritoneclaude
andcommitted
Add updated readme to webamp-demo package
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 63320aa commit aaf7a62

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

packages/webamp-demo/readme.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Webamp.org
2+
3+
The Webamp demo site, [webamp.org](https://webamp.org), uses the same interface as the NPM module but adds the following functionality by utilizing Webamp's public API
4+
5+
- Error reporting using [Sentry](https://sentry.io)
6+
- Analytics using [Google Analytics](https://analytics.google.com/analytics/web/)
7+
- Updating document's title to reflect the currently playing track
8+
- [Media Session API](https://developer.mozilla.org/en-US/docs/Web/API/Media_Session_API) integration
9+
10+
Additionally, it makes use of some private Webamp APIs to add the following functionality:
11+
12+
- [Butterchurn](https://github.com/jberg/butterchurn) integration to render [MilkDrop](https://en.wikipedia.org/wiki/MilkDrop) visualizations. We intend to make this part of the public API soon.
13+
- "Screenshot" mode `https://webamp.org/?screenshot=1` which can be used together with [Puppeteer](https://github.com/GoogleChrome/puppeteer) to automate the generation of Winamp skin screenshots
14+
15+
## Development
16+
17+
pnpm start
18+
19+
## Production Builds
20+
21+
To do an optimized build of the demo site:
22+
23+
pnpm run build
24+
25+
To test the production build locally:
26+
27+
pnpm run serve
28+
29+
## Deploying
30+
31+
[Netlify](https://www.netlify.com/) watches GitHub for new versions of master. When a new version is seen, it is automatically built and pushed to the server. Additionally, Netlify will run a build on every pull request and include a link under the heading "Deploy preview ready!".
32+
33+
In short, deploying should be as simple as pushing a commit to master.
34+
35+
### Advanced Usage
36+
37+
There are some "feature flags" which you can manipulate by passing a specially crafted URL hash. Simply supply a JSON blob after the `#` of the URL to change these settings:
38+
39+
- `skinUrl` (string) Url of the default skin to use. Note, this file must be served with the correct Allows Origin header.
40+
- `audioUrl` (string) Url of the default audio file to use. Note, this file must be served with the correct Allows Origin header.
41+
- `initialState` (object) Override the initial Redux state. Values from this object will be recursively merged into the actual default state.
42+
43+
**Note:** These are intended mostly as development tools and are subject to change at any time.

0 commit comments

Comments
 (0)