/lexical-amplifier-node-app

A Node dictionary application that returns definitions for queried words and allows you to export the results of your searches in an Excel file.

Primary LanguageJavaScriptGNU Affero General Public License v3.0AGPL-3.0

Lexical Amplifier (Node edition)

A Node dictionary application that returns definitions for queried words and allows you to export the results of your searches in an Excel file.

Prerequisites

In order to successfully run the Lexical Amplifier, you will need to obtain API credentials from Oxford Dictionaries. To obtain your API credentials, visit https://developer.oxforddictionaries.com/?tag=#plans.

Installation & Setup

  • Download this repo
  • Obtain your Oxford Dictionaries API credentials
  • Use the ".env.example" file as a template to create your .env file containing your API credentials
  • Open a Node terminal and change the directory to the folder containing the contents of this repo
  • Enter "npm install" to install the dependencies
  • Enter "node app" to run Lexical Amplifier

License

This project is licensed under the AGPL-3.0-only license - see the LICENSE.md file for details.

Background

This is my second independent project since I began learning how to program in spring 2018. It served as the starting point for a full-stack version of the app as well.

One of my goals for 2018 has been to make headway in working my way through reading the backlog of books in my personal library. When reading, I like to note every word that I am unfamiliar with and look it up in the dictionary. That served as the inspiration and impetus for Lexical Amplifier, and developing it was a great way to expand and strengthen my programming skills.