From 365126d278e724045ab543fbfd61dfc6c7d68150 Mon Sep 17 00:00:00 2001 From: Samundra Shrestha Date: Thu, 25 Jan 2018 21:52:04 +0700 Subject: [PATCH] update readme, fix typos --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 37fea5d..2ef78be 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,32 @@ # Simple Backend for http://dafuq.is -It a simple python script which calls urabndictionary api +Dafuq is a simple python script which calls [urbandictionary](https://www.urbandictionary.com/) API for a given word and returns the response. The server is -written using `bottle` (dependency supplied with repo) and -`requests`. +written in python, using `bottle` and `requests`. ## Requirements + - `bottle` (Supplied with code, no need to install) - `requests` v2.1.14 -## Running +## How to get up and running ? + - `$ pip install -r requirements.txt` - `$ python ./src/index.py` -### For Wordnik -If you want to use wordnik source, you need to create a api key. +### For [Wordnik](https://www.wordnik.com/) + +If you want to use wordnik source, you need to create an API key. After you have an API key do. - `$ cp .env.example .env` - Modify .env so that you paste your environment variable - `$ source .env` -- `$ DAFUQ_IS_WORDNIK_API_KEY=${DAFUQ_IS_WORDNIK_API_KEY} python3 ./src/index.py` +- `$ DAFUQ_IS_WORDNIK_API_KEY=${DAFUQ_IS_WORDNIK_API_KEY} python ./src/index.py` -Note: The app will run on localhost on port 8080, +**Note:** The app will run on localhost on port 8080, we then setup our nginx proxy to forward requests from our web front to the app. +