rest_api_sarthak v1.0.0

Testing,Documenting,and Linting Code With Jest,JsDoc,Eslinting

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 dependencies

npm i -D jest

Install the Jsdoc dependencies

npm i -D jsdoc

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

• 10.0.0
  • Initial release