add README + clean everything up

Author: sidgonuts

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Sid Nutulapati
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,35 @@
-# news-aggregator
+# news-aggregator
+
+An early build of a service that collects and analyzes news articles. Done with [NewsAPI.org](https://newsapi.org/) and [Indico](https://indico.io).
+
+![screenshot](mvp_homepage.png)
+
+Ugly as hell, I know. PRs welcome!
+
+## Purpose
+
+This is an MVP of the idea found [here](https://medium.com/@captainsidd/paying-for-a-news-aggregator-e88364fbfc0d). Branched off from the original idea somewhat, mostly to make building this more doable in a 24 hour hackathon - vast majority of this was done at Brickhack 4.
+
+## Installation
+
+You'll need API keys for both the NewsAPI and Indico. Once you have those, make the file `./lambda/environment.yml`:
+
+``` yaml
+NEWS_API_KEY: xxxxxxxxxx
+INDICO_KEY: xxxxxxxxxx
+```
+
+Then install [Serverless](https://serverless.com), and make sure you can deploy to AWS with AWS credentials setup in your `bash_profile`
+
+To deploy:
+
+```sh
+cd lambda
+npm install
+sls deploy
+```
+
+This will display two different endpoints, the base of which should replace `const BASE_URL` in `news-aggregator-web/src/App.js`.
+
+Note: Haven't got the frontend up and running anywhere - want to handle the rate limit issue for the Indico API before the site is publically available.
+

index.html

@@ -68,6 +68,7 @@ def query_article(event, context):
 def select_parse_random(news_articles):
     """
     Takes given news articles and returns a max of 20 random articles, leaving only important data
+    @TODO: Figure out how to make this better. 20 random articles isn't the best representation of the days news.
     """
     indexes = []
     if len(news_articles['articles']) < 20:

lambda/handler.py

@@ -72,9 +72,6 @@ class App extends Component {
                 </div>
                 <button type="submit" className="btn btn-default">Search</button>
               </form>
-              <ul className="nav navbar-nav navbar-right">
-                <li><a href="#">Link</a></li>
-              </ul>
             </div>
           </div>
         </nav>