fluffy-api

command module
v0.0.0-...-0b529df Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 10, 2017 License: MIT Imports: 10 Imported by: 0

README

Fluffy Radio Api Twitter Follow

A wrapper API for the Spacial Audio Cloud API

Linux Build Windows Build License
Build Status Build status license

This API is designed to wrap the somewhat ugly and non-standard Spacial Audio Cloud API. The wrapper is built in Go and proxies requests to Spacial Audio. The API is publised to Pivotal Web Services.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

There are a few things you need to do before you begin working on the project.

  1. Install Go, we've used Go 1.7.4
  2. Install Glide for dependency management
  3. Have access to a Spacial Audio Cloud Station ID and Token
Installing

A few things have to be done to run the API. Ensure you have git clone'd the site first.

  1. Run glide install
  2. Run go build
  3. Run ./fluffy-api --spacial-id=SPACIALSTATIONID --spacial-token=SPACIALSTATIONTOKEN

Running Tests

  1. Run go test

Deployment

This code repository is connected and published to Pivotal Web Services, a Cloud Foundry distribution. The Travis CI build is the source for the deployment.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

Versioning

We use SemVer for versioning.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT license - see the LICENSE file for details.

Acknowledgments

  • PurpleBooth for sample README and CONTRIBUTING file Gists

Documentation

Overview

The Fluffy Radio API

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL