Skip to content
/ xmtp-js Public

XMTP client SDKs for Browsers and Node, content types, and other packages written in TypeScript

Notifications You must be signed in to change notification settings

xmtp/xmtp-js

Repository files navigation

XMTP JS content types

This repo provides JavaScript implementations of content types you can use with your app built with the XMTP client SDK for JavaScript or React.

To learn more about the contents of this repository, see this README and the READMEs provided for packages.

What's inside?

Packages

Requirements

  • Node 18+
  • Yarn v3+ is required only when working with this repo. See Yarn Installation, or run the setup-yarn script in the /dev directory.

Running tests

Before running unit tests, a required Docker container must be started. To do so, start Docker and run yarn test:setup. Run yarn test:teardown to stop the Docker container.

Useful commands

  • yarn build: Build all packages
  • yarn clean: Remove all node_modules, .turbo, and build folders, clear Yarn cache
  • yarn format: Run prettier format and write changes on all packages
  • yarn format:check: Run prettier format check on all packages
  • yarn lint: Lint all packages
  • yarn test: Test all packages
  • yarn typecheck: Typecheck all packages