README.md

Define

Define is the command line tool i use on my machine as a dictionary, it is inspired by Google's define search ( if you notice when you search on google with the word "define" comes before any word you want, you do get the definition of that word ). as i use linux as my daily drive , i use alias on the .bashrc file to call the command define and use it on my daily basics.

Prerequisites

• Node.js.
• Git.
• Marriam-Webster Dictionary API get your own API Key.
• Linux ( only if you want use this tool by following this doc, however can change use alias on your corresponding OS ).

Installation

clone the repo

if you have https auth on github

git clone https://github.com/kaleabAlemayehu/define.git

if you have ssh auth on github

git clone [email protected]:kaleabAlemayehu/define.git

Install all dependencies of the project

npm i

configure your own API key

1. create a file called .env
2. store your API key in the following format

DIC=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
THE=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

3. store the command on your terminal alias

alias define='node /project's absolute path'

Usage

there are 2 parameters when you the tool, those are the word you want the definition and the number of word type you want, it depend on the word you choose wheather the word type become noun, adjective, verb, adverb. but if you want the word type more than one. you can pass it as parameter in the command like this

define peach 4

• the first parameter is the word.
• how many definition you want about the word.