Making Inline Audio Easy and Seamless
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
build
soundcite
website
.gitignore
CHANGELOG
DEVELOPER.md
LICENSE
README.md
config.json
fabfile.py
requirements.txt

README.md

Inline audio players. Easy to make. Seamless to publish.

Usually adding audio to a text story is an uncomfortable choice. Either the user reads or listens but never both. Until now.

SoundCite is a simple-to-use tool that helps content creators add audio to their stories. The audio is not isolated in a player positioned off to the side, interrupting the text or housed in a garish player that distracts content consumers from reading.

SoundCite's audio is just a link that plays right under the relevant text.

SoundCite audio adds emotion or context to the text. It never asks users to look away from what they are reading. And, most importantly, it requires no technical skills to use.

Customizing your SoundCite player

You can customize the basic colors and styles of Soundcite clips using CSS. See this page for more information. It's more complicated to change the progress animation, but that is also explained on that page.

Development

Requires:

  • the KnightLab fablib repository which should be co-located with the soundcite repo.
  • Python 2.7.x
  • Node & npm

Setup

  • create a virtualenv (Python 2)
  • pip install -r requirements.txt
  • npm install less -g
  • npm install uglify-js -g
  • fab -l to see available build commands

Additonally: Set your WORKON_HOME environment variable to point to the location of your virtualenvironments.

Web application development

The web application is hosted at http://soundcite.knightlab.com. This is where users can create embed codes. In development, it runs as a Flask application via fab serve. For deployment, it is compiled into a static site.

The web application and its assets are located in the website directory of this repository.