aldizh / dictionaryapi_tests

Basic testing framework to test dictionary API

Dictionary API Tester

A Simple Jest Framework to test Dictionary APIs

Required

• Please make sure node is installed on your system (v15.x preferred)
• Also please install npm for managing our packages
• Download Guides: Node NPM

Setting up the project

1. Clone the repository on your local machine

git clone [email protected]:Aldizh/dictionaryapi_tests.git

2. Go to cloned directory

cd dictionaryapi_tests

4. Create a .env file in your project root directory containing the api authentication key

AUTH_KEY=Basic _YOUR_API_KEY_

5. Install dependencies listed in package.json

npm install

Running the test suite

1. To run the entire suite

npm run test

2. Run with live monitoring

npm run test:monitor

Main third party libraries used

• express (for setting up a basic server)
• supertest (for making HTTP requests to the api routes)
• axios (for making network calls to the public API)

Learn

• Jest
• Node