-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
11 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
|