joaovictorpsantos/dictionary-cli

a cli made with yargs, node, flowjs and others tools

dictionary-cli

CLI application to find meaning of English Words

🚀 Features

• You can pass a word to the CLI and it will search the API for the meaning along with more information

🎯 Tools used

• NodeJS to create a CLI
• FlowJS to static type checker
• Babel to compile JavaScript
• ESLint to standardize
• Prettier to format code
• GitHub Actions to CI

👷 Installation

You need to install Node.js and NPM first, then in order to clone the project via HTTPS, run this command:

  git clone https://github.com/joaovictorpsantos/dictionary-cli.git

SSH URLs provide access to a Git repository via SSH, a secure protocol. If you have a SSH key registered in your Github account, clone the project using this command:

  git clone [email protected]:joaovictorpsantos/dictionary-cli.git

Install dependencies

  npm install

🏃 Getting Started

On Linux

The dictionary-cli file should have executable permission:

  chmod u+x ./dictionary-cli.sh

And run:

  ./dictionary-cli.sh "Hello"

Output:

On Windows

Run

  ./dictionary-cli.js "Hello"

Output:

Let's share knowledge and grow together!!!

---

Author: João Victor Pereira Santos