Table of Contents
pnpm installFirst, run the development server:
pnpm run devpnpm run buildpnpm run testSee the full testing guide.
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
Common configurations have been abstracted to make customizing this dashboard for your own DAO as easy as possible.
Modify :root (light) and :dark values in index.css -- convert hex values into RGB and set the existing primary, secondary, accent, etc.
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.
Import the font at the top of index.css, then set the font-family to the font name.
To add support for new wallets, modify the wallet selector setup in lib/wallet.
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.