Skip to content

F documentation alex #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alexander-l-stone wants to merge 2 commits into
base: master2
Choose a base branch
from
Open

F documentation alex #26

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
32aa1ff
Update README.md
alexander-l-stone Oct 19, 2018
3443d62
Update README.md
alexander-l-stone Oct 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 16 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@
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](https://github.com/DeToxers/DeToxipyClient)
Expand Down Expand Up @@ -33,10 +29,8 @@ ___
- Python3
- Javascript ES6
- Django 2.1.1
- Twitch Dev Rig
- Twitch Chat Bot
- Twitch Messaging Interface
- D3
- Kubernetes

___
<a id="overview"></a>
Expand All @@ -46,7 +40,7 @@ ___
___
## Getting started
<a id="start"></a>
- 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.
- Clone all the repositories. Start the chatbot server, the django server, and the D3 server.
___

## Routes
Expand All @@ -57,7 +51,7 @@ ___

- **Usage:**

Gets data for the data visualization for the current session.
Gets json chat data out of database.

- **Output:**
```
Expand All @@ -68,24 +62,20 @@ Code Block

- **Usage:**

Post route for list view and detail view of the messages.
Post route for sending JSON of chat to our database.

- **Output:**
```
`
Code Block
```
___
## Models
<a id="models"></a>

- **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.
- **ChatText**

Holds the data for the current stream session. Stores it in the database in JSON.
```
___
<a id="contrib"></a>
## Contributing to our project
Expand All @@ -104,3 +94,11 @@ ___
- Twitch Documentation
- D3 Documentation
___
<a id="Special Thanks"></a>
## Special Thanks
- Michael Sklepowich
- JJ Feore
- Shannon Tully
- Brian Nations
- James Salamonsen
- Benjamin Hurst