Skip to content

Latest commit

 

History

History
60 lines (47 loc) · 1.97 KB

README.md

File metadata and controls

60 lines (47 loc) · 1.97 KB
Raw

Pipo

License Build Version Docker Image Poetry Sphinx

Bot to interactively play music in your Discord channel.

Installation

Runtime prerequisites

The application is compatible with Windows and Linux based systems. Since both constitute runtime dependencies, Docker + Docker Compose are assumed to be installed and configured.

Development only

In case poetry is not locally installed:

make poetry_setup

For being able to run the test suite do:

make dev_setup

For additional help try:

make help

Considering Docker to be already installed, one is able to create the app docker image with

make image

How to run

Test suite

Before running the suite make sure file '/tests/.secrets.yaml' was created in accordance with the available example.

make test

Containerized application (Docker)

Before running more commands make sure file '.env' was created in accordance with the available example.

Start a single container with

make run_image

Start the complete application with

make run_app

License

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