General Dictionary

Welcome! You've arrived at the General Dictionary ReadMe!

About

The goal of this tool is to allow users to easily connect to and pull data from two separate dictionary-based endpoints at once - a random word generator located at https://random-words-api.vercel.app/word, and a public dictionary database with documentation located at https://dictionaryapi.dev/.

Laguages Used

HTML, CSS, JavaScript, JQuery, AJAX, Google Fonts

Build Status

This work is a WIP, and is publicly accessible for collaboration or feedback.

Future Features & Challenges

The main stretch goals of this project are below:

Locate another endpoint that can be accessed at the highest level - https://dictionaryapi.dev/ limits our ability to loop over all word names in the array. Because of this, we have been unable to build a "did you mean?" search feature, and therefore will provide a frustrating user experience when typos inevitably occur. A workaround for this is to copy/paste all word names from the GitHub repository associated with https://dictionaryapi.dev/, but that has a tangible impact on speed and overall defeats part of the purpose of this project, which is to work dynamically with the API's and not house their data within our code.
Connect to various translation-focused endpoints to generate equally comprehensive definitions/pronunciations across multiple languages, as providing a multi-lingual experience would optimize the tool.
Add Local Favorites Functionality. Users can currently only access one master list of bookmarked words and can only clear it all at once. Goal will be to expand functionality to allow users to expand details on Favorited words as well as remove individual items.
Add more interactivity and visual stimulation onto the page; improve styling.

Usage and Navigation Instruction

The tool generates a randomized word on page-load, and also features a word search tool that allows end-users to search for a specific word's definition, origin, synonyms, antonynms, and pronunciation on-demand. The usage of the General Dictionary is ultimately quite simple - using primarily JavaScript & Query, output the following:

A random word on page-load, generated from the random-words-api and cross-checked against https://dictionaryapi.dev/. Once a successful match is located, the tool will spit out random word data using the more comprehensive definition data contained within https://dictionaryapi.dev/. A failed match will cause the function to re-run until a match is located successfully.
A searched-for word based on whatever a user inputs into the "General Dictionary Search" field.

To utilize the randomized vocabulary word tool, simply refresh the page or, if desired, click the "Generate new word" button to populate a new word:

Clicking "Show details" will run the Random Word throutgh the General Word Search and provide more information including synonyms, pronunciation, etc:

To utilize the "General Word Search" feature, type your word of choice into the displayed search bar and either click "Go" or hit Enter/Return on your keyboard to populate the chosen word's defintion data:

Contributors/Reference

Provide Feedback

Have feedback you would like to share? Want to see a feature added? Want to contribute? Send me an email!