Getting Started

This guide walks you through setting up the Rugdrome monorepo, compiling the smart contracts, and running the test suite.

Prerequisites

• Node.js (LTS recommended)
• npm or pnpm
• Git
• (Optional) Foundry for Solidity fuzz and invariant tests

Clone the Repository

git clone https://github.com/TerexitariusStomp/equalizer-improved.git
cd equalizer-improved

Install Dependencies

npm install

Environment Variables

Copy the example environment file and fill in the required values:

cp .env.example .env

Edit .env:

# Private key used for deployment (keep secret)
PRIVATE_KEY=

# Blockscout API key for Robinhood Chain verification
ROBINHOOD_BLOCKSCOUT_API_KEY=

# Enables gas reporter in tests
REPORT_GAS=

WARNING

Never commit .env or any private key. This repository uses .gitignore to exclude sensitive files.

Compile Contracts

npm run compile

Run Tests

npm run test

Run the Full E2E Suite

npx hardhat test test/e2e.js

Run Foundry Tests

forge test

Run the Frontend

cd frontend
npm install
npm run dev

The frontend will be available at http://localhost:3000 by default.

Run the Documentation Site

cd docs
npm install
npm run dev

The docs will be available at http://localhost:5173/docs/ by default.

Next Steps

• Read the Architecture overview.
• Explore the Smart Contracts reference.
• Learn how to deploy the protocol.