README.md

Boardroom Project Information Repo

This public repo contains project information which will be served to display on the Boardroom Governance Portal
Browse the Portal »

Landing · Discord · Get In Touch

About

All project additions and edits for information uploaded, stored, and maintained on the Boardroom Portal occur on this public Project Information repository. These docs will walk you through how to add the necessary information to this repository in a few simple steps, to get your project added to the Boardroom Portal frontend and to update its details on an ongoing basis.

Development

Clone the repo:

$ git clone git@github.com:boardroom-inc/protocol-Info.git

Install dependencies:

$ yarn

Compile the protocol info artifact to dist:

$ yarn build

Link the package:

$ yarn link

From hub-ui (or any other repo), use the linked package:

$ yarn link @boardroom/protocol-info

Quick Add New Protocol:

$ ./scripts/add_new_protocol $protocolName $tokenContractAddress (optional) $suffix (optional) $displayName (optional)

Run validation:

$ yarn validate

Cut a new release:

$ git checkout main
$ git pull
$ npx standard-version
$ yarn publish
$ git push origin main --follow-tags

Contact

Please reach out in Discord with any questions!

• Boardroom Support Channel - #❓support