helloworld_ankit v1.0.0

Testing,Documenting,and Linting an API With Jest,JsDoc,Eslinting,Swagger-jsDoc

This project is intended to be used as assignment as to how one would document and test their code and check the coverage of the source code to then turn into API Documentation.

Table of Contents

1. Installation
2. Testing
3. Building the Documentation
4. Release History

1. Installation

Setup a new or existing npm package

npm -init -y

Install the Jest dependency: it is for unit testing of our project

npm i -D jest

Install the Jsdoc dependency: it is for documenting our code

npm i -D jsdoc

Install the axios dependency: Axios is a Javascript library used to make HTTP requests from node.js or XMLHttpRequests from the browser that also supports the ES6 Promise API.

npm i -D axios

Install the Swagger-JsDoc and Swagger-ui dependency: it is for api documentation

npm i -D swagger-jsdoc swagger-ui-express

Install the eslint: it is for format the code in standard manner and remove some common error on its own

npm i -D eslint

2. Testing

Testing the project arithmetic

npm run test

3. Building the Documentation

Build the jsdoc documentation from the source code

npm run doc

4. Release History

• 0.0.1
  • Initial release