Instadapp/boardroom-inc-protocol-Info
1
0
Fork 0
mirror of https://github.com/Instadapp/boardroom-inc-protocol-Info.git synced 2024-07-29 22:37:02 +00:00
Code Issues Packages Projects Releases Wiki Activity
Information about protocols
445 Commits 29 Branches 37 Tags 12 MiB
TypeScript 86.8%
Shell 13.2%
fae2925420
Go to file
yj fae2925420 fix: overview
2021-05-17 14:52:07 -05:00
__unsupported Create Update Week 18 2021 06-05-21.md 2021-05-06 15:57:05 -04:00
.github chore: consolidate protocol info and add validation tooling (#85) 2021-04-13 12:47:41 -05:00
protocols fix: overview 2021-05-17 14:52:07 -05:00
scripts fix: reove all empty govnernae.jsons 2021-05-04 18:03:11 -05:00
.gitignore fix: ignore index.js 2021-04-29 12:00:07 -05:00
.prettierrc.js chore: prettier 2021-04-22 13:25:49 -05:00
allprotocols.json fix: dont overwrite if already claimed 2021-04-27 20:40:32 -05:00
CHANGELOG.md chore(release): 2.2.14 2021-05-13 23:44:10 -05:00
index.d.ts fix: index.d.ts 2021-04-28 21:49:25 -05:00
LICENSE Initial commit 2021-01-11 17:54:31 +05:30
package.json chore(release): 2.2.14 2021-05-13 23:44:10 -05:00
README.md fix: update readme 2021-05-02 11:42:26 -05:00
tsconfig.json chore: export compiled artifact (#107) 2021-04-16 18:09:56 -05:00
types.ts fix: validate types 2021-04-24 19:04:51 -05:00
yarn.lock fix: buildscript 2021-04-28 21:45:25 -05:00

README.md

Discord Twitter


Boardroom

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!