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.
eslint-config-xmtp-web
: An opinionated ESLint configuration for XMTP web projectsreact-sdk
: React XMTP client SDKreact-components
: Experimental: React components for building React apps with XMTPtsconfig
: Internal package for sharingtsconfig.json
files
react-quickstart
: A quickstart example app using React, Vite, and RainbowKit
- 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 runningyarn set version berry
to upgrade to a compatible version.
After installing the requirements, run yarn && yarn dev
to start developing.
yarn build
: Builds thepackages/react-sdk
andpackages/react-components
packagesyarn clean
: Remove allnode_modules
,.turbo
, and build folders, clear Yarn cacheyarn quickstart
: Buildspackages/react-sdk
andpackages/react-components
, then runs theexamples/react-quickstart
app in dev mode.yarn format
: Run prettier format and write changes on all packagesyarn format:check
: Run prettier format check on all packagesyarn lint
: Lint all packagesyarn test
: Test all packagesyarn typecheck
: Typecheck all packages