@x-saim/json_the_cat
v1.0.1
Published
A command line app that allows users to access The Cat API's breed descriptions from the terminal.
Downloads
3
Readme
Cat Breed Description Fetcher
The Cat Breed Description Fetcher is a command line app that fetches information about cat breeds from The Cat API and provides users with a short description of the breed they are interested in. This app serves as a proof of concept for querying datasets through the terminal and is built with Node.js.
Installation
To use this app, you need to have Node.js installed on your machine. You can download Node.js from https://nodejs.org/.
- Clone this repository or download the ZIP file and extract it to your desired location.
- Open your terminal and navigate to the directory where the app is located.
- Run the command
npm install
to install the necessary dependencies.
Usage
To run the app, use the command node index.js
followed by the name of the cat breed you want to search for. For example:
node index.js siamese
This will fetch information about the Siamese breed from the API and print out a short description.
Testing
This app includes test code written using Mocha and Chai. To run the tests, use the command npx mocha
or npm test
in your terminal.
Contributors
This app was created by @x-saim. If you would like to contribute to the project, please feel free to submit a pull request.