Skip to content

Project Overview

gilpanal edited this page Jun 14, 2020 · 6 revisions

To understand the fully scope of this project you would also need to check out:

The purpose of the three components is to create an ecosystem for musicians and other people interested in audio to share their work in a free way, bringing the power of bots and real time communication, the ease and universal integration of an API for any client and the accessibility and grateful experience of a cross-platform Web App.

Architecture

Architecture Diagram Audio Data Flow

Bot

The bot repository is independent and can be fully run at localhost. Two requirements are mandatory in order to set it up properly:

  1. Firebase Database
  2. Telegram Bot Token

The code structure is as follows:

  • Bot code based on Telegraf.js to process messages: bot.js, bot_helper.js
  • DB handler to delegate Firebase library the database operations: dbhandler
  • WebDevServer to visually check some of the bot actions: webdevserver
  • Config folder to handle sensitive information like Bot token or DB url for different environments

Clone this wiki locally