⚠ IMPORTANT❗❗

👀 READ BEFORE STARTING TO WORK WITH THIS TEMPLATE

About this Template

Use this template to quickly create an NPM package.

Please review and complete the following checklist in order to get started:

• [ ] Find all occurrences of al3x-pkg-test1 in your project created from the template and replace it with your package name. Make sure your package name follows the package name guidelines.

• [ ] Make sure your package.json file is correctly configured. Check that fields name, description, keywords, repository, bugs and others are according with what the project needs.

• [ ] In the file jest.config.json you can find an example of how you can set the coverage paths that will be ignored (line # 5). Configure your custom paths or delete that line of code.

• [ ] Make sure that the files .gitignore, .eslintignore and .eslintrc.js meet the needs of the project.

• [ ] You can find some examples of code in folders ./lib and ./tests. Check the folder structure, naming files/folders, among others. Then, create your folders and files. Finally, DELETE unused files/folders.

• [ ] Update this README file with the real information about this new package. Be sure to DELETE this section.

Helpful Links

• How to ignore files from your npm package
• The .npmignore File
• Keeping files out of your Package
• About semantic versioning
• Package entry points
• Package exports
• Github license selector

---------------- DELETE THE PREVIOUS LINES ----------------

al3x-pkg-test1

Table of Contents

• Overview
• Quick Start
  • Install
  • Usage
• How to run locally
  • Prerequisites
  • Installation
  • Fill environment variables
  • Run locally
• Run unit test and coverage
• Contributors

Overview (or Why)

Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here.

Other highlights could be:

• Why you used the technologies you used
• Some of the challenges you faced and features you hope to implement in the future

Quick Start

Install

Using npm:

npm install my-package

Usage

/*
 * Use examples liberally, and show the expected output if you can. 
 * It's helpful to have inline the smallest example of usage that you can demonstrate, 
 * while providing links to more sophisticated examples included in this README file or other sources.
 * 
 */

How to run locally

Prerequisites

• NodeJs 14
• Include extras

Installation

Install dependencies

npm i

Fill environment variables

Provide instructions and examples with KEY and possible VALUES for environment variables.

Run locally

Provide instructions and examples so users/devs can use the package.

// Use examples liberally 

Run unit test and coverage

Run

npm test

To run code coverage use

npm run coverage

Contributors

• @DevUser01
• @DevUser02