Skip to content

apjaffe/DictionaryAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

88 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DictionaryAPI

Backend for this repository.

Functionality

Finds difficulty ratings, definitions, and synonyms of words by sending requests to dictionary.com. Results are cached to avoid sending repeated requests.

Endpoints

  • GET /get_definition
    • key: word
    • returns: {definition: (string)}
  • GET /get_difficulty
    • key: word
    • returns: {difficulty: (int)}
  • GET `/get_synonym
    • key: word
    • returns: {difficulty: (string)}
  • POST /get_definitions
    • key: words (array of strings)
    • returns: {(dict of key=word, val=(string))}
  • POST /get_difficulties
    • key: words (array of strings)
    • returns: {(dict of key=word, val=(int))}
  • POST /get_synonyms
    • key: words (array of strings)
    • returns: {(dict of key=word, val=(string))}

(the bulk endpoints are POST because GET urls become too long)

node-js-getting-started

A barebones Node.js app using Express 4.

This application supports the Getting Started with Node on Heroku article - check it out.

Deploy to Heroku

Running Locally

Make sure you have Node.js and the Heroku Toolbelt installed.

$ git clone git@github.com:heroku/node-js-getting-started.git # or clone your own fork
$ cd node-js-getting-started
$ npm install
$ npm start

Your app should now be running on localhost:5000.

Deploying to Heroku

$ heroku create
$ git push heroku master
$ heroku open

Documentation

For more information about using Node.js on Heroku, see these Dev Center articles:

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 11