clrfund-admin

A GUI for managing and deploying CLRFund.

Starting a CLRFund funding round is simplified and streamlined into 3 steps:

1. Use this application to create a new CLRFund instance (initial setup only).
2. Clone the clr.fund repository and deploy the web application (vue-app) on Netlify.
3. Use this application to start a new funding round.

This application employs a deployment design that ensures the security of the CLRFund instance and the matching pool by using multisig wallets, specifically Gnosis Safe.

Contract data is indexed in a universal subgraph. Please refer to chain.ts for the chain specific URL. Keep in mind that this URL may change in the future when transitioning to TheGraph's decentralized subgraph. Additionally, you have the option to deploy your own subgraph instance to index the contract data. Refer to the clr.fund documentation for instructions on deploying your custom subgraph.

Development

Install the dependencies

pnpm i

Setup environment variables

Copy the .env.example in the vue-app directory to .env and update the WalletConnect project id with your own Id

Start the admin app

pnpm dev

Run unit tests

pnpm test

Deploy to Netlify

Set environment variables

NUXT_PUBLIC_IPFS_GATEWAY_URL=
PNPM_FLAGS=--shamefully-hoist

Build Settings

Base directory: /
Build command: vue-app
Build command: pnpm --filter './vue-app' run generate
Publish directory: vue-app/dist

Limitations

See issues for a list of limitations to be addressed.

Tech stack resources

• /vue-app
  • Vue 3
  • Pinia
  • Ethers v6
  • MACI
  • unenv
  • Web3 Onboard
  • Safe SDK
  • Heroicons
  • Vitest
  • eslint
  • tailwindcss
  • Nuxt
  • NuxtUI
  • Nuxt Color Mode