Skip to content
The web interface for the Cacophony Project API
Branch: master
Clone or download
clare Merge pull request #175 from clare/feedback-if-animal
Add observation dialogue now offers feedback on when animal is allowed.
Latest commit 5011d2a May 23, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Merge branch 'master' into feedback-if-animal May 23, 2019
webpack Copy favicon resources into output directory Sep 24, 2018
.babelrc updaded npm packages Mar 21, 2019
.eslintignore Config tweaks to allow local only dev config file. Aug 17, 2018
.eslintrc.js Replace ENV usage with a config module Sep 19, 2018
.gitignore Rename dev.js to dev-config.js Sep 19, 2018
.travis.yml Reencrypt Github creds against May 10, 2019 Update name in README to cacophony-browse Oct 29, 2018
index.template.ejs Add / to href paths in index.template.ejs to avoid favicon path errors Nov 28, 2018
jest.config.js Use test config as default Sep 19, 2018
nfpm.yaml Update release files and name. Oct 29, 2018
package-lock.json Merge commit '3e98f165111279bee2f0ec9caba673f34d7994f0' into overlay Apr 5, 2019
package.json Made it default that dev server can be seen over local network. May 15, 2019
update-nfpm-version Add support for releasing as a Debian package Aug 20, 2018


This is a web interface for querying with and interacting with Cacophony Project recordings using the project's API. It is based on the Vue framework and uses Vuex for state management.

Build Setup

# install dependencies
npm install

# create config file
cp dev-config.js.TEMPLATE to dev-config.js
# now edit the config file to point to correct API server

# serve with hot reload at localhost:8080
npm run dev

# build for staging & production with minification
npm run release

For detailed explanation on how things work, consult the docs for vue-loader.


Please follow the Vue style guide for all development:


  • Ensure all changes have been merged and are pulled into the local copy.
  • Tag the release (starting with a "v"), e.g.: git tag -a v1.2.3 -m "1.2.3 release"
  • Push the tag to Github, e.g.: git push origin v1.2.3
  • TravisCI will run the tests, create a release package and create a Github Release

Web Server Configuration

The /srv/cacophony/cacophony-browse directory in the release package should be served by a web server.

Sample configuration for the Caddy web server:

# Update the host and port to match desired
http://localhost:9000 {
    root  /srv/cacophony/cacophony-browse

    rewrite {
        ext !.jpg !.png !.svg !.js
        to /index-prod.html  # or index-staging.html
You can’t perform that action at this time.