Skip to content

DeToxers/detoxipy_api

Repository files navigation

Detoxipy Server

The server-side of a Twitch extension that allows users to visualize trending keywords in a Twitch chat using bubbles that grow and shrink depending on popularity.


AWS

AWS

GitHub(Client)

https://github.com/DeToxers/DeToxipyClient

GitHub(Server)

https://github.com/DeToxers/DeToxipyServer


Branches

  • Test
  • Master

Table of contents


Tools

  • Python3
  • Javascript ES6
  • Django 2.1.1
  • Twitch Dev Rig
  • Twitch Chat Bot
  • D3
  • Kubernetes

Overview

Wireframe


Getting started

  • Clone the repository and ensure you have Docker and Docker Compose installed. Run "docker-compose up --build" from your command line and then go to localhost in your browser.

Routes

GET: api/v1/bubble

  • Usage:

    Gets data for the data visualization for the current session.

  • Output:

Code Block

POST: api/v1/chat

  • Usage:

    Post route for list view and detail view of the messages.

  • Output:

Code Block

Models

  • Session

    Holds the data for the current stream session. This table's contents are deleted at the end of each session. It is used to calculate the most common words per time period/

  • Main

    Holds the historical data for the streamer. At the end of each session, the top 5 words for that session are added to this table. This table is used for data visualization of chat trends over time.


Contributing to our project

  • Thanks for your interest in our project! Please name your branch according to the following convention: f_featurename_yourname. Then please make a pull request back to our master branch and we will review it.

Participants

  • Max McFarland
  • Luther Mckeiver
  • Chris Chapman
  • Madeline Peters
  • Alex Stone

Sources

  • Twitch Documentation
  • D3 Documentation

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors