/snickers

Snickers is an open source alternative to the existent cloud encoding services.

Primary LanguageGoApache License 2.0Apache-2.0



[![Build Status](https://travis-ci.org/snickers/snickers.svg?branch=master)](https://travis-ci.org/snickers/snickers) [![codecov](https://codecov.io/gh/snickers/snickers/branch/master/graph/badge.svg)](https://codecov.io/gh/snickers/snickers) [![Go Report Card](https://goreportcard.com/badge/github.com/snickers/snickers)](https://goreportcard.com/report/github.com/snickers/snickers)

Snickers is an open source alternative to the existent cloud encoding services. It is a HTTP API that encode videos.

Setting Up

First make sure you have Go and FFmpeg with --enable-shared installed on your machine. If you don't know what this means, follow the instructions.

Download the dependencies:

$ make build

If you have a MONGODB_HOST set on the configuration file, Snickers will use it to store jobs and presets. Otherwise it will use the memory.

Run!

$ make run

Running tests

Make sure you have mediainfo installed and run:

$ make test

Using the API

Check out the Wiki to learn how to use the API.

Contributing

  1. Fork it
  2. Create your feature branch: git checkout -b my-awesome-new-feature
  3. Commit your changes: git commit -m 'Add some awesome feature'
  4. Push to the branch: git push origin my-awesome-new-feature
  5. Submit a pull request

License

This code is under Apache 2.0 License.