mirror of
https://github.com/informaticker/discord-jellyfin-bot.git
synced 2024-11-23 18:21:55 +01:00
67 lines
1.6 KiB
Markdown
67 lines
1.6 KiB
Markdown
<p align="center">
|
|
<a href="http://nestjs.com/" target="blank"><img src="https://github.com/walkxcode/dashboard-icons/blob/main/png/jellyfin.png?raw=true" width="200" alt="Nest Logo" /></a>
|
|
</p>
|
|
|
|
<br/>
|
|
<h1 align="center">Jellyfin Discord Bot</h1>
|
|
|
|
<p align="center">A simple <a href="https://discord.com" target="_blank">Discord</a> bot that enables you to broadcast your <a href="https://jellyfin.org/" target="_blank">Jellyfin Media Server</a> music collection to voice channels.</p>
|
|
|
|
<p align="center">
|
|
<small>Thanky you KGT1 for starting this project! This is a fork of their original repository and re-uses some of their code.</small>
|
|
</p>
|
|
|
|
|
|
<br/>
|
|
<hr/>
|
|
<br/>
|
|
|
|
|
|
## ✨ Features
|
|
|
|
- Leighweight and extendable using the [Nest](https://github.com/nestjs/nest) framework
|
|
- Easy usage with Discord command system (eg. ``/play``, ``/pause``, ...)
|
|
- Fast configuration via environment variables
|
|
- Typesafe for faster and easier development
|
|
|
|
## 🚀 Installation
|
|
|
|
```bash
|
|
$ 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:
|
|
|
|
```bash
|
|
# development
|
|
$ npm run start
|
|
|
|
# watch mode
|
|
$ npm run start:dev
|
|
|
|
# production mode
|
|
$ npm run start:prod
|
|
```
|
|
|
|
```bash
|
|
# unit tests
|
|
$ npm run test
|
|
|
|
# e2e tests
|
|
$ npm run test:e2e
|
|
|
|
# test coverage
|
|
$ npm run test:cov
|
|
```
|
|
|
|
## 👤 Credits
|
|
- https://tabler-icons.io/ (MIT)
|
|
- https://docs.nestjs.com/ (MIT)
|
|
- https://discord.js.org/ (Apache 2.0) |