Skip to content
/ xmtp-web Public

XMTP web SDKs and examples, including a React SDK and quickstart example app

Notifications You must be signed in to change notification settings

xmtp/xmtp-web

Repository files navigation

XMTP web SDKs and examples

This is the official repository for XMTP web SDKs and examples, powered by Turborepo.

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

What's inside?

Packages

Examples

Requirements

  • Node 18+
  • React 16.14+
  • Yarn v3+ is required only when working with this repo. See Yarn Installation.

    Tip
    If you have an earlier version of yarn installed, try running yarn set version berry to upgrade to a compatible version.

Developing

After installing the requirements, run yarn && yarn dev to start developing.

Useful commands

  • yarn build: Builds the packages/react-sdk and packages/react-components packages
  • yarn clean: Remove all node_modules.turbo, and build folders, clear Yarn cache
  • yarn quickstart: Builds packages/react-sdk and packages/react-components, then runs the examples/react-quickstart app in dev mode.
  • 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