@likersocial/wallet-connector
TypeScript icon, indicating that this package has built-in type declarations

0.20.1 • Public • Published

LikeCoin Wallet Connector

This is a useful frontend library for integrating various wallet connections, including:

Usage

npm i react react-dom @likecoin/wallet-connector

Please refer to the example for detailed integration in Nuxt.js.

NOTE: @likecoin/wallet-connector/dist/style.css must be imported for styling.

Commands

The recommended workflow is to run TSDX in one terminal:

yarn start

This builds to /dist and runs the project in watch mode so any edits you save inside src causes a rebuild to /dist.

Then run either the example or Storybook playground:

Example

Run the example inside another terminal:

cd example
yarn # To install dependencies
yarn dev

Storybook

Run inside another terminal:

yarn storybook

This loads the stories from ./stories.

NOTE: Stories should reference the components as if using the library, similar to the example playground. This means importing from the root project directory. This has been aliased in the tsconfig and the storybook webpack config as a helper.

Configuration

Code quality is set up for you with prettier, husky, and lint-staged. Adjust the respective fields in package.json accordingly.

Jest

Jest tests are set up to run with npm test or yarn test.

Bundle analysis

Calculates the real cost of your library using size-limit with npm run size and visulize it with npm run analyze.

Rollup

TSDX uses Rollup as a bundler and generates multiple rollup configs for various module formats and build settings. See Optimizations for details.

TypeScript

tsconfig.json is set up to interpret dom and esnext types, as well as react for jsx. Adjust according to your needs.

Continuous Integration

GitHub Actions

Two actions are added by default:

  • main which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
  • size which comments cost comparison of your library on every pull request using size-limit

Optimizations

Please see the main tsdx optimizations docs. In particular, know that you can take advantage of development-only optimizations:

// ./types/index.d.ts
declare var __DEV__: boolean;

// inside your code...
if (__DEV__) {
  console.log('foo');
}

You can also choose to install and use invariant and warning functions.

Module Formats

CJS, ESModules, and UMD module formats are supported.

The appropriate paths are configured in package.json and dist/index.js accordingly. Please report if any issues are found.

Named Exports

Per Palmer Group guidelines, always use named exports. Code split inside your React app instead of your React library.

Readme

Keywords

none

Package Sidebar

Install

npm i @likersocial/wallet-connector

Weekly Downloads

1

Version

0.20.1

License

GPL-3.0-or-later

Unpacked Size

1.01 MB

Total Files

69

Last publish

Collaborators

  • karathrace