You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 17, 2026. It is now read-only.
-[`ccip-js`](/packages/ccip-js/README.md): A TypeScript library that provides a client for managing cross-chain token transfers that use Chainlink's [Cross-Chain Interoperability Protocol (CCIP)](https://docs.chain.link/ccip) routers.
14
-
-[`ccip-react-components`](/packages/ccip-react-components/README.md): A set of prebuilt ready-to-use UI components built on top of `ccip-js`.
13
+
### Start here
14
+
15
+
The CCIP JavaScript SDK is a monorepo for two packages:
16
+
17
+
-[`ccip-js`](/packages/ccip-js/README.md): A TypeScript library that provides a client for managing cross-chain token transfers that use Chainlink's [Cross-Chain Interoperability Protocol (CCIP)](https://docs.chain.link/ccip) routers.
18
+
-[`ccip-react-components`](/packages/ccip-react-components/README.md): A set of prebuilt ready-to-use React UI components. This package depends on `ccip-js`.
15
19
16
-
Using both packages, you can add a fully featured CCIP bridge to your app that can be styled to match your app design.
17
-
18
-
To view more detailed documentation and more examples, visit the [Chainlink Javascript SDK Documentation](https://docs.chain.link/ccip/ccip-javascript-sdk/).
20
+
Using both packages, you can add a fully featured CCIP bridge to your app that can be styled to match your app design.
21
+
22
+
To view more detailed documentation and more examples, visit the [Chainlink Javascript SDK Documentation](https://docs.chain.link/ccip/ccip-javascript-sdk/). Development specific information is also found in individual READMEs inside the `./packages/<<PACKAGE_NAME>>` directory.
23
+
24
+
There is also an example implementation of a front end NextJS app that uses these packages in `./examples/nextjs`. That has its own README as well.
If you want to make changes to the package code, you need to rebuild the packages and make sure package.json file to point to the updated local versions.
50
+
If you want to make changes to the package code, you need to rebuild the packages.
51
+
Then:
46
52
47
-
Make sure to build the `ccip-js` package before you build the `ccip-react-components` package. The React components depend on the JS package.
53
+
1. Make sure to build the `ccip-js` package before you build the `ccip-react-components` package. The React components depend on the JS package.
54
+
55
+
2. Make sure your client's package.json file to points to the updated local versions or use npm link or equivalent in your downstream client code. You can see examples of this in the steps below.
0 commit comments