https://github.com/niweera/wordhound
WordHound Service which provides custom dictionary with a database support for the WordHunter project.
https://github.com/niweera/wordhound
express googleappengine javascript nodejs
Last synced: 6 months ago
JSON representation
WordHound Service which provides custom dictionary with a database support for the WordHunter project.
- Host: GitHub
- URL: https://github.com/niweera/wordhound
- Owner: Niweera
- License: mit
- Archived: true
- Created: 2019-08-05T19:31:00.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T18:26:19.000Z (about 3 years ago)
- Last Synced: 2025-02-16T21:43:27.816Z (12 months ago)
- Topics: express, googleappengine, javascript, nodejs
- Language: JavaScript
- Homepage: https://wordhound.niweera.gq
- Size: 9.41 MB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://opensource.org/licenses/MIT)
[](http://hits.dwyl.io/Niweera/wordhound)
[](https://snyk.io//test/github/Niweera/wordhound?targetFile=package.json)
[](https://travis-ci.com/Niweera/wordhound)
# WordHound
> WordHound service is a supporting service for WordHunter project which provides custom dictionary caching with database support. More details on WordHunter project as follows.
## Getting Started
To view the meaning of a specific word, enter the word at the provided endpoint. The WordCache DB is the store for all the words and definitions. WordHound learns new words everytime it is being used.
Eg. `https://wordhound.niweera.gq/words/hello`, will give you the dictionary definition of **hello** directly from the WordCache DB:
```json
{
"word": "hello",
"definition": "used as a greeting or to begin a telephone conversation."
}
```
Eg. `https://wordhound.niweera.gq/words/find/hello`, will give you the dictionary definition of **hello** even if the word is not present in the WordCache DB:
```json
{
"word": "hello",
"definition": "used as a greeting or to begin a telephone conversation."
}
```
### Paths
| Location | Endpoint |
| :-- | :-- |
| Root path | `https://wordhound.niweera.gq/`|
### HTTP request and query methods
| Method | Endpoint | Query | Description | Examples |
| :-- | :-- | :-- | :-- | :-- |
| `GET` | `/words` | `{word}` | Give JSON response with the definitions of the `{word}` directly from the WordCache DB. | [`hello`](https://wordhound.niweera.gq/words/hello) |
| `GET` | `/words/find` | `{word}` | Use this endpoint if the previous endpoint does not provide any definition. When using this endpoint to get the definition, the WordCache DB learns new words. | [`hello`](https://wordhound.niweera.gq/words/find/hello) |
## Related Projects
### WordHunter
> WordHunter lets you to find the words for the letters you have when you are playing Scrabble.
The following is the basic architecture of the WordHunter application. (The web application will use the WordHunter-api to get the results according to the letters that the user has given.)
### Example use case
User wants to find words which can be created from `a, o, n, t`
The WordHunter service will provide the following results.
1. nato - North Atlantic Treaty Organization.
(The initial version would only give the words which contains all the letters. Later versions would provide all the letter combinations.)
## Meta
Nipuna Weerasekara – [@Niweera](https://twitter.com/Niweera) – w.nipuna@gmail.com
Distributed under the MIT license. See ``LICENSE`` for more information.
The front-end for WordHunter application is in [https://github.com/Niweera/wordhunter](https://github.com/Niweera/wordhunter)
The back-end for this application is in [wordhunter-api](https://github.com/Niweera/wordhunter-api) repo.
[https://github.com/Niweera/wordhound](https://github.com/Niweera/wordhound)
This repo is a part of `WordHunter` project.
`WordHunter` uses [GoogleDict](https://dict.niweera.gq) Dictionary API service. Find its repo [here](https://github.com/Niweera/googledict).
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new Pull Request
[npm-image]: https://img.shields.io/npm/v/datadog-metrics.svg?style=flat-square
[npm-url]: https://npmjs.org/package/datadog-metrics
[npm-downloads]: https://img.shields.io/npm/dm/datadog-metrics.svg?style=flat-square
[travis-image]: https://img.shields.io/travis/dbader/node-datadog-metrics/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/dbader/node-datadog-metrics
[wiki]: https://github.com/yourname/yourproject/wiki