⚠️ Deprecation Notice

ModuleKit was developed by Rhinestone and is no longer actively supported. If you're building modules and need assistance, reach out to Rhinestone at gm@rhinestone.dev

title: "Getting Started"

Getting Started

ModuleKit is built on top of Foundry (opens in a new tab), a toolchain to simplify and speed up smart contract development. If you are not familiar with Foundry, feel free to check out their docs and install it by running:

curl -L https://foundry.paradigm.xyz | bash

Installation

Using our template

Use the module-template (opens in a new tab) to create a new repo and install the dependencies:

pnpm install

Using a package manager

npm

npm i @rhinestone/modulekit
cp node_modules/@rhinestone/modulekit/remappings.txt remappings.txt

yarn

yarn add @rhinestone/modulekit
cp node_modules/@rhinestone/modulekit/remappings.txt remappings.txt

pnpm

pnpm i @rhinestone/modulekit --shamefully-hoist
cp node_modules/@rhinestone/modulekit/remappings.txt remappings.txt

Using git submodules

forge install rhinestonewtf/modulekit
cd lib/modulekit
pnpm install