cplayer
is a small, statically served, client-side album-based audio player for modern web browsers. You simply drop a build into a directory on your web server, create a manifest.json
file that describes the album metadata and track URIs and you're done.
It looks something like this:
I recorded some music and wanted to share it with a couple other people, but didn't want to bother creating a SoundCloud account, upload them to YouTube, or send them via email. I just wanted to host my own music and provide a simple, lightweight web-based player for others to use to listen to the audio.
- Download a release, and extract it to a directory on your web server.
- Create a
manifest.json
file in theassets/
subdirectory. This is a simple JSON file that contains:- A list of
albums
and their respective tracks - An optional
config
structure to tweak the runtime behavior of the player. - An example
manifest.json
can be found here. Fields should be self-explanatory.
- A list of
- You're done! Load the page and you should be good to go.
cplayer
is easy to build, all you need is a working NodeJS
installation and yarn
.
- Clone the repository
cd cplayer
yarn
yarn dev
# starts the development server with hot reload onhttp://localhost:3000
yarn build
# creates a static build in thedist/
subdirectory