prestd-api-client

Template to kickstart creating a Node.js module using TypeScript and VSCode

Inspired by node-module-boilerplate

Features

• Semantic Release
• Issue Templates
• GitHub Actions
• Codecov
• VSCode Launch Configurations
• TypeScript
• Husky
• Lint Staged
• Commitizen
• Jest
• ESLint
• Prettier

Getting started

Set up your repository

Click the "Use this template" button.
Alternatively, create a new directory and then run:

curl -fsSL https://github.com/MoustaphaDev/prestd-api-client/archive/main.tar.gz | tar -xz --strip-components=1

Replace FULL_NAME, GITHUB_USER, and REPO_NAME in the script below with your own details to personalize your new package:

FULL_NAME="John Smith"
GITHUB_USER="johnsmith"
REPO_NAME="my-cool-package"
sed -i.mybak "s/MoustaphaDev/$GITHUB_USER/g; s/prestd-api-client\|prestd-api-client/$REPO_NAME/g; s/Moustapha Happy/$FULL_NAME/g" package.json package-lock.json README.md
rm *.mybak

Add NPM Token

Add your npm token to your GitHub repository secrets as NPM_TOKEN.

Add Codecov integration

Enable the Codecov GitHub App here.
Remove everything from here and above

---

!npm packagenpm-imgnpm-url !Build Statusbuild-imgbuild-url !Downloadsdownloads-imgdownloads-url !Issuesissues-imgissues-url !Code Coveragecodecov-imgcodecov-url !Commitizen Friendlycommitizen-imgcommitizen-url !Semantic Releasesemantic-release-imgsemantic-release-url

My awesome module

Install

npm install prestd-api-client

Usage

import { myPackage } from 'prestd-api-client';

myPackage('hello');
//=> 'hello from my package'

API

myPackage(input, options?)

input

Type: string
Lorem ipsum.

options

Type: object

postfix

Type: string Default: rainbows
Lorem ipsum.