tswf-player's Introduction

Tasty Shapes With Friends - API

A tiny SaaS for sharing song links with your friends over a common stream.

About

You can build full documentation for this project by doing the following:

$ cd doc/
$ make html
$ make -b coverage

generated documentation is stored in doc/build/html, with a report of any undocumented code in doc/build/coverage.

tswf-player is a media player for interacting with a queue that serves as a playlist fromtswf-api:

tswf-api serves the flask routes for interacting with the queue
tswf-player plays song links submitted to the queue by calling the api

This project is intended to be run with docker-compose. Depending on what operating system you are using, you may want to grab it from your package manager, or directly from upstream.

should be able to simply run:

docker build -t <name> .

and after you've built the container:

docker-compose up -d or docker run -d -p8081:8081 player:latest

NGINX

It's assumed that the API and Player are sitting behind NGINX. Included in this repository is an example rtmp.conf. The rtmp.conf should be included within its own block of your nginx.conf. An example nginx.conf is provided below:

user  nginx;
worker_processes  1;

events {
    worker_connections  1024;
}

http {
    include       mime.types;
    default_type  application/octet-stream;

    ssl on;
    ssl_session_cache	shared:SSL:10m;
    ssl_session_timeout	10m;
    ssl_session_tickets	off;

    sendfile        on;
    keepalive_timeout  70;
    include /etc/nginx/conf.d/api.conf;
}

include /etc/nginx/conf.d/rtmp.conf;

NGINX needs to be built with the RTMP Module in order to serve player content. Compile NGINX with the following ./configure flag: --add-module=/path/to/nginx-rtmp-module

Built With

Contributing

Fork the repository
Clone the project from your forked repository to your macine
Commit changes to your own branch
Push your changes on your branch to your forked repository.
Submit a Pull request back to our repository for review.

NOTE: always merge from latest upstream before submitting pull requests.

Versioning

Semantic Versioning will be used to version this project. Please consult the releases page for a complete list of available versions.

Authors

License

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

Acknowledgements

verboten the IRC bot currently serving as the DJ for the live version running among friends. Written by d3d1rty

tswf-player's People

Contributors

Watchers

tswf-player's Issues

ptdel / tswf-player Goto Github PK