Casimir Web

Casimir self-custodial restaking platform

• About
• Get Started
  • Prerequisites
  • Setup
  • Configure
  • Usage
    • Install
    • Dev
    • Build
    • Preview
• License

About

Casimir is a complete platform that allows users to monitor, move, and stake their assets while holding their own keys. With Casimir staking, users can easily and securely move funds in and out of decentralized staking pools that are operated by high-performing validators.

Get Started

Get started contributing to Casimir's codebase.

Prerequisites

Configure the following prerequisite global dependency versions:

1. Git (v2.x).

2. Node.js (LTS).

Note

Using NVM: Install NVM and run nvm install --lts && nvm alias default lts/* to set the default version to the latest LTS.

Setup

Clone the repository and checkout a new branch from develop.

git clone https://github.com/casimirlabs/casimir.git
cd casimir
git checkout -b <"feature || bug || enhancement">/<"your-branch-name" develop

Configure

Customize and override the development environment configuration by creating a .env file in the root directory.

Note

Any environment variable that needs to be available during runtime must use the PUBLIC_ prefix.

Name	Description	Default
PUBLIC_NETWORK	Network name (mainnet or holesky)	holesky
PUBLIC_ETHEREUM_RPC_URL	Ethereum RPC URL	http://127.0.0.1:8545
PUBLIC_CRYPTO_COMPARE_API_KEY	CryptoCompare API key	""
PUBLIC_WALLET_CONNECT_PROJECT_ID	WalletConnect project ID	""

Usage

Use the package.json interface to run project commands.

Install

Install all project dependencies.

npm install

Dev

Run the web app in development mode.

npm run dev

Build

Build the web app for production to the dist folder.

npm run build

Preview

Run the web app in production mode.

npm run preview

License

This respository is available as open source under the terms of the Apache License.