Giter Club home page Giter Club logo

azuri's Introduction

Azuri Logo

Azuri: A Discord bot for AzuraCast

Build Status Apache 2.0 License Ethical Open Source DeepScan grade Twitter Follow Invite Image

Azuri is a simple but powerful Discord bot to intergrate the open-source web radio management suite AzuraCast into your Discord community.

Invite

Invite Image

Overview Photos

Azuri is currently in active development with new features and bugs fixed on the daily and is not a final product in any means. Azuri was created to support new radio's that use AzuraCast and provide a platform to connect the radio and community.

Hosted or Self Hosted?

Azuri is hosted allowing anyone to invite the bot using this invite into their server and experiance it to it's full potential. Want to go the extra mile and make it custom? Fllow the steps below.

Installing Self-Hosted Version

Azuri is open-source, so you can host your own! If you want to customize something or just want a seocnd that's fine!

Via Docker (Recommended)

Requirements:

  • Docker
  • Docker Compose (included with Docker Desktop for Windows or Mac)

Installation and Usage

  1. Copy azuri.sample.env to azuri.env
  2. Edit azuri.env with your BOT_TOKEN
  3. Run docker-compose up -d

*¹ - This can be generated here view a guide here

Direct Installation

Requirements:

Installation & Usage

To install and run follow these steps:

  1. Copy azuri.sample.env to src/.env
  2. Change into the src directory
  3. Edit .env with your BOT_TOKEN
  4. Run npm ci
  5. Run npm run azuri

Dependencies Used

We use multiple packages to make sure the bot is the easiest to use and navigate for the end-user.

Discord.JS w/ Opus offical NodeJS library.

Axios used for API calls

dotenv used for .env files and enviroment variables

ffmpeg used for audio streaming

fs used for storing data in files

Dev Resources

nodemon hot reloading for development

eslint used for code functionaility and error checking

Bug Reporting

Found a bug? Report it!

Before reporting please check Issues and Projects

Feature Request

Thought of a great idea? Reuqest it!

Before requesting please check Issues and Projects

Support

Azuri is provided free of charge but if you feel it's useful support us!

Azuri

Buy Me a Coffee at ko-fi.com

Azura

Check for their infomation!

License

Azuri is licensed under the Apache license, version 2.0. This project is free and open-source software, pull requests are always welcome along with bug and feature reports/requests

azuri's People

Contributors

busterneece avatar ninjalabs-dev avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.