Builder Dashboard

Homebase for Build DAO management

Table of Contents

• Getting Started
  • Installing dependencies
  • Running the app
  • Building for production
  • Running tests
• Contributing

Getting Started

Installing dependencies

pnpm install

Running the app

First, run the development server:

pnpm run dev

Building for production

pnpm run build

Running tests

pnpm run test

See the full testing guide.

Project Structure

This project uses @Kiranism's beauitful react-shadcn-starter-dashboard, which is built on the following stack:

• Js Library - React 18
• Language - TypeScript
• Styling - Tailwind CSS
• Components - Shadcn-ui
• Schema Validations - Zod
• Async state management - Tanstack Query aka React Query
• Tables - Tanstack Tables
• Forms - React Hook Form
• Linting - ESLint
• Formatting - Prettier
• Pre-commit hook - Husky

It also includes further integrations to connect to the NEAR Protocol:

• NEAR Client - Naxios
• Wallet - NEAR Wallet Selector
• State management - Zustand

Customizing

Common configurations have been abstracted to make customizing this dashboard for your own DAO as easy as possible.

Colors

Modify :root (light) and :dark values in index.css -- convert hex values into RGB and set the existing primary, secondary, accent, etc.

Logos

Set the assets for logo-icon and logo-text in assets. Further configure by changing elements for specific variants (main-hero, mobile-sidebar, dashboard-sidebar, etc) in components/dao.

Fonts

Import the font at the top of index.css, then set the font-family to the font name.

Wallets

To add support for new wallets, modify the wallet selector setup in lib/wallet.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you're interested in contributing to this project, please read the contribution guide.