Skip to content

Latest commit

 

History

History
101 lines (65 loc) · 3.41 KB

README.md

File metadata and controls

101 lines (65 loc) · 3.41 KB
Raw

Better

How to submit your idea

Visit /better-app/issues and add a new issue.

To list your issue on your Better board, tag the issue category as bug or feature and its status as open, planned or inProgress.

Your issue should now appear on better.betterhq.org.

You can now:

👉 login with Discord and vote on your favorite issue

👉 add funds to the issue to start a bounty

👉 work on a bounty and claim the bounty pool once finished.

How to set up Better for your organization

Better mirrors your Github issues to a hosted website, which allows your community to vote on them, fund them as bounties and claim the pooled funds for implementing them. Issues could range from feature requests, to DAO proposals or content marketing ideas.

Setting up your own Better project takes a few steps:

  • Fork the Better repo
  • Set up Vercel
    • Add a new project, linking to your forked repo
    • Set your ENV variables (Ask us on Discord!)

After a successful deployment, point your vercel deployment to your custom URL, eg. feedback.yourdapp.com, roadmap.yourdapp.com, bounties.yourdapp.com

  • Copy your DNS info at https://vercel.com/[yourproject]/[yourrepo]/settings/domains
  • Add the info in your domain manager interface

🎊 Congratulations, you just deployed your custom Better site 🎉

How to customize your Better site

Set your project name and custom footer links in this config file: \better-app\src\config.ts

Better mirrors each Github issue based on its tags. The default tags are open, inProgress, live. If you want to set your own, edit the following files:

  • \better-app\src\config.ts
  • src/features/issues/components/issues-list-page.tsx
  • src/features/issues/constants.ts
  • src/features/issues/types.ts

You want to customize your site's UI or got feature ideas for Better? Join our Discord and let us know!

Dev

Checkout the repo and set the required environmental variables by copying ./.env.example into ./.env.local.

Next, install the dependencies:

npm install
# or
yarn install

Run the development server:

npm run dev
# or
yarn dev

FAQ

How to set up Guild.xyz to allow voting with NEAR wallets
  1. Head to guild.xyz and create your own guild
  2. Add a new role
  3. Add an allowlist with the addresses that should be able to vote
    • Convert NEAR addresses to HEX format (eg here)
    • Add 0x in front of the address, and enough 0s to fill the total string to 42
    • Eg. 0x000000003761696d656e73638e746573746e6574
  4. After saving and signing the Metamask request, the whitelisted addresses should be able to vote
How to set up Guild.xyz to allow voting with Ethereum / Metamask
  1. Head to guild.xyz and create your own guild
  2. Add a new role
  3. Add an allowlist with the addresses that should be able to vote
  4. After saving and signing the Metamask request, the whitelisted addresses should be able to vote