Skip to content

akure/dao-dao-ui

 
 

Repository files navigation

DAO DAO UI

This project creates a web UI for the DAO DAO smart contracts, enabling users to:

  • create a governance token-based DAO, membership-based DAO (multisig), or other type of DAO.
  • create and vote on proposals.
  • view the treasury and manage it democratically.

All without having to code!

You can find more info in our documentation. Join the DAO DAO Discord if you're interested in becoming a contributor.

Deployment with Vercel

Because of the server memory resource requirements for the build of this application, we are using Github Actions to deploy this applcation to Vercel.

Vercel Preview

  • This workflow runs on any branch that isn't main and uses Vercel credentials to...
    • authenticate with Github Secrets,
    • pull preview build environment from Vercel,
    • build the packages on the Github Actions runner, and
    • deploy to preview the previously built packages.

Vercel Production

  • This workflow runs on branch, main, and uses Vercel credentials to...
    • authenticate with Github Secrets,
    • pull production build environment from Vercel,
    • build the packages on the Github Actions runner, and
    • deploy to preview the previously built packages.

Development

Clone this repo and install dependencies

git clone https://github.com/DA0-DA0/dao-dao-ui
cd dao-dao-ui
yarn

If you're here to work on UI components in isolation, you will likely want to run the Storybook server to mock up components and iterate quickly without having to access live chain data. Check out the storybook package README for usage instructions.

To start the Storybook server, run this command from the root of this monorepo:

yarn storybook start

If you're here to work on any other part of the app, likely accessing live chain data, run the yarn dev script (equivalent to running yarn dev from the ./apps/dapp package) to run the main app in development mode.

yarn dev

If something is misconfigured, check out the docs for Turborepo, the monorepo build system we use.

Packages

/apps

App Summary
dapp DAO DAO UI hosted at https://daodao.zone.

/packages

Package Summary
config Configurations for various dev tools.
email Email template and generator tools.
i18n Internationalization/translation system.
state State retrieval and management for the DAO DAO UI.
stateful Stateful components, hooks, and systems that access and manipulate live data.
stateless React components, React hooks, and other stateless rendering utilities which do not access live data.
storybook Storybook server configuration and story decorators.
types Types used across packages.
utils Utility functions used across packages.

Contributing

Interested in contributing to DAO DAO? Check out CONTRIBUTING.md.

Disclaimer

DAO DAO TOOLING IS PROVIDED “AS IS”, AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND. No developer or entity involved in creating the DAO DAO UI or smart contracts will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of DAO DAO tooling, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.

About

InterChain DAO tooling UI.

Resources

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 99.3%
  • Other 0.7%