discord-jellyfin-bot/README.md
Manuel d9b399d253
📝 Code review
Co-authored-by: Meier Lukas <meierschlumpf@gmail.com>
2022-12-18 19:25:11 +01:00

1.6 KiB

Nest Logo


Jellyfin Discord Bot

A simple Discord bot that enables you to broadcast your Jellyfin Media Server music collection to voice channels.

Thanky you KGT1 for starting this project! This is a fork of their original repository and re-uses some of their code.




Features

  • Leighweight and extendable using the Nest framework
  • Easy usage with Discord command system (eg. /play, /pause, ...)
  • Fast configuration via environment variables
  • Typesafe for faster and easier development

🚀 Installation

$ git clone https://github.com/manuel-rw/jellyfin-discord-music-bot.git
$ cd jellyfin-discord-music-bot/
$ yarn
$ yarn start:prod

Docker container comming soon

💻 Development

I'm open to any contributions to this project. You can start contributing using the following commands, after executing the installation commands:

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod
# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

👤 Credits