sample-package-esqueleton

A simple esqueleton package meant for starter packages

Usage no npm install needed!

<script type="module">
  import samplePackageEsqueleton from 'https://cdn.skypack.dev/sample-package-esqueleton';
</script>

README

Sample NPM Package - Esqueleton

Build Status

A simple starter package to create your own npm module with API requests. This module was created with the intention to teach new node developers on how to create a module that uses an Apikey.

Quick Use

const { SampleApiRequestHandler } = require('sample-package-esqueleton'); 
const client = new SampleApiRequestHandler();

client
  .getApiRequest({ id: '1' })
  .then(data => console.log(data));

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

npm v6.9.0

node v10.16.3

Installing

npm install

Running the tests

Test are powered with Mocha and Chai

npm test

Coding Style

Coding style is standard and can be found on .eslintrc.json

Deployment

If you want to install this package using npm simply install

npm i sample-package-esqueleton

Generate docs

npm run docs

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments