Safe Reserve

Getting Started

Follow these steps to start the application:

1. Install Dependencies

   pnpm install

2. Configure Environment Variables

   cp .env.example .env.local

3. Start the Development Server

   pnpm dev

Open http://localhost:3000 with your browser to see the result.

---

Environment Variables

Ensure the following environment variables are properly configured:

• NEXT_PUBLIC_MAINNET_NODE_URI – Mainnet RPC URL
• NEXT_PUBLIC_WALLETCONNECT_PROJECT_ID – WalletConnect Project ID
  • You can get this from WalletConnect Cloud

---

Scripts Information

Available scripts for development and maintenance:

• Development

  pnpm dev

  Starts the development server.

• Build

  pnpm build

  Creates a production build.

• Production

  pnpm start

  Runs the production server.

• Type Checking

  pnpm typecheck:ci

  Runs TypeScript type checking.

---

Project Structure

The project follows a modular architecture with the following key directories:

• app/ – Next.js app directory containing pages and layouts
• components/ – Reusable React components
• contracts/ – Smart contract definitions and ABIs
• core/ – Core application logic and business rules
• hooks/ – Custom React hooks
• lib/ – Utility functions and shared libraries
• public/ – Static assets
• routes/ – Application routing configuration
• utils/ – Helper functions and utilities
• views/ – Page-specific components and logic

Important information for contributors

As a contributor to the Gearbox Protocol GitHub repository, your pull requests indicate acceptance of our Gearbox Contribution Agreement. This agreement outlines that you assign the Intellectual Property Rights of your contributions to the Gearbox Foundation. This helps safeguard the Gearbox protocol and ensure the accumulation of its intellectual property. Contributions become part of the repository and may be used for various purposes, including commercial. As recognition for your expertise and work, you receive the opportunity to participate in the protocol's development and the potential to see your work integrated within it. The full Gearbox Contribution Agreement is accessible within the repository for comprehensive understanding. [Let's innovate together!]