From 32aa1ff41169fc82febc606be1f5b5f096d09575 Mon Sep 17 00:00:00 2001
From: Alex Stone <37088323+alexander-l-stone@users.noreply.github.com>
Date: Fri, 19 Oct 2018 09:20:20 -0700
Subject: [PATCH 1/2] Update README.md
Updated readme with up to date information on the app.
---
README.md | 31 ++++++++++++++-----------------
1 file changed, 14 insertions(+), 17 deletions(-)
diff --git a/README.md b/README.md
index ee0d3b9..d617051 100644
--- a/README.md
+++ b/README.md
@@ -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)
@@ -33,10 +29,8 @@ ___
- Python3
- Javascript ES6
- Django 2.1.1
-- Twitch Dev Rig
-- Twitch Chat Bot
+- Twitch Messaging Interface
- D3
-- Kubernetes
___
@@ -46,7 +40,7 @@ ___
___
## 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.
+- Clone all the repositories. Start the chatbot server, the django server, and the D3 server.
___
## Routes
@@ -57,7 +51,7 @@ ___
- **Usage:**
- Gets data for the data visualization for the current session.
+ Gets json chat data out of database.
- **Output:**
```
@@ -68,23 +62,19 @@ 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
-- **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**
+- **ChatText**
- 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.
+ Holds the data for the current stream session. Stores it in the database in JSON.
___
@@ -104,3 +94,10 @@ ___
- Twitch Documentation
- D3 Documentation
___
+
+- Michael Sklepowich
+- JJ Feore
+- Shannon Tully
+- Brian Nations
+- James Salamonsen
+- Benjamin Hurst
From 3443d626e2f88be52a5c1cf5b61540e34502fb0e Mon Sep 17 00:00:00 2001
From: Alex Stone <37088323+alexander-l-stone@users.noreply.github.com>
Date: Fri, 19 Oct 2018 09:21:09 -0700
Subject: [PATCH 2/2] Update README.md
Fixed code block errors in the markdown.
---
README.md | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index d617051..cf61c82 100644
--- a/README.md
+++ b/README.md
@@ -75,7 +75,7 @@ ___
- **ChatText**
Holds the data for the current stream session. Stores it in the database in JSON.
-
+```
___
## Contributing to our project
@@ -95,6 +95,7 @@ ___
- D3 Documentation
___
+## Special Thanks
- Michael Sklepowich
- JJ Feore
- Shannon Tully