victorchao996 / simple-dictionary

This is an simple application that you can serach for the word definition.

Simple Dictionary

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Notices

About The Project

Intro 介紹

This is an simple application that you can serach for the word definition.

Built With

• node.js

• npm package

  • colors
  • axios

• Dictionary API: The Merriam-Webster Dictionary API

(back to top)

Getting Started

Prerequisites

• node
• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/VictorChao996/weird-language-guesser.git

2. Install NPM packages

   npm install

(back to top)

Usage

• After install you can simply execute by the terminal. Pass your input as the argument to the index.js file.

node index.js [word]

Example

Success result:

Search the word "victor"

node index.js victor

Failure result:

The respone will be the recommended word you could search for if the input is unknown.

node index.js hellllo

(back to top)

Notices

Warning

• The API call has a limited in 1000 calls per day.The script will not be able to work if the limit was reached.

Note

• This is a simple project on practice calling the API.
• The idea was inspired from the tutorial: https://teamtreehouse.com/library/nodejs-basics-3/project-overview