Back to Web3 Js

web3.js - Package Template

tools/web3-packagetemplate/README.md

4.16.02.3 KB
Original Source
<p align="center"> </p>

web3.js - Package Template

This is a sub-package of web3.js.

web3-packagetemplate contains the ideal setup for a Web3.js package.

Installation

You can install the package either using NPM or using Yarn

Using NPM

bash
npm install web3-packagetemplate

Using Yarn

bash
yarn add web3-packagetemplate

Getting Started

Prerequisites

Package.json Scripts

ScriptDescription
cleanUses rimraf to remove dist/
buildUses tsc to build package and dependent packages
lintUses eslint to lint package
lint:fixUses eslint to check and fix any warnings
formatUses prettier to format the code
testUses jest to run unit tests
test:integrationUses jest to run tests under /test/integration
test:unitUses jest to run tests under /test/unit