infotition-npm-boilerplate v1.0.1

Table of Contents

• Table of Contents
• Credits
• Installation
• Commands
• Issue Reporting
• Contribution
• License

Credits

This boilerplate is heavily based on metachris's npm Boilerplate: https://github.com/metachris/typescript-boilerplate. We adjusted it to fit our needs.

Installation

NPM is a node package manager, so make sure you have it and node.js installed.

Clone the repository and change the directory of your terminal to the downloaded folder.

$ git clone https://github.com/Infotition/npm-boilerplate.git
$ cd codeli

Install all packages using the npm install command.

$ npm install

Now everything should be working fine. If you have any problems, don't hesitate to join our official discord server.

Commands

This boilerplate covers following npm scripts:

• npm run cli - Runs the cli script.
• npm run test - Runs the jest test suits.
• npm run lint - Checks if the typescript files are linted.
• npm run docs- Creates the documentation using TypeDoc.
• npm run clean - Cleans the build directory.
• npm run build:all - Builds the package, cli and browser version.
• npm run build - BUilds the node package.
• npm run esbuild:browser - Builds the browser version.
• npm run esbuild:cli - Builds the cli version.

Issue Reporting

If you have found a bug or if you have a feature request, please report them at this repository issues section. For other related questions/support please use the official Infotition Discord server.

Contribution

We appreciate feedback and contribution to this repo! Before you get started, please see the following:

• Infotition Code of Conduct guidelines
• Infotition Contribution guidelines

License

This repo is covered under the MIT License, see the LICENSE file for more information.