From 11ad264499d51bddcda705c002f65a80d39c04d3 Mon Sep 17 00:00:00 2001 From: denim2x Date: Fri, 8 Mar 2019 12:58:36 +0000 Subject: [PATCH] Add Readme.md --- Readme.md | 17 +++++++++++++++++ public/index.html | 2 +- 2 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 Readme.md diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..349dfa4 --- /dev/null +++ b/Readme.md @@ -0,0 +1,17 @@ +# News intelligence engine + +Web app for browsing entities found within news articles + +## Setup + +First you should have certain variables in your environment: +- `NEWSAPI_KEY`: API key for [News API](https://newsapi.org) +- `DANDELION_TOKEN`: auth token for [Dandelion API](https://dandelion.eu/) +- `GRAPHAPI_KEY`: API key for [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/) + +```sh +npm install +npm start +``` + +Launches a Web server at port `process.env.PORT` - open your browser to view the app in action. diff --git a/public/index.html b/public/index.html index 838b995..33c9f45 100644 --- a/public/index.html +++ b/public/index.html @@ -4,7 +4,7 @@ News intelligence engine - +