boardroom-inc-protocol-Info/README.md

89 lines
2.2 KiB
Markdown
Raw Normal View History

<p align="center">
<a href="https://discord.gg/CEZ8WfuK8s">
<img src="https://img.shields.io/badge/Discord-Join-7289da?style=for-the-badge&logo=discord&logoColor=white" alt="Discord" />
</a>
<a href="https://twitter.com/boardroom_info">
<img src="https://img.shields.io/badge/Twitter-Follow-1da1f2?style=for-the-badge&logo=twitter&logoColor=white" alt="Twitter" />
</a>
</p>
2021-01-15 00:09:06 +00:00
2021-01-14 23:47:50 +00:00
<br />
<p align="center">
<a href="http://app.boardroom.info/">
<img src="https://i.ibb.co/PFcchnQ/boardroom.png" alt="Boardroom" width="450" />
2021-01-14 23:47:50 +00:00
</a>
2021-01-14 14:48:48 +00:00
2021-01-14 23:47:50 +00:00
<h3 align="center">Boardroom Project Information Repo</h3>
<p align="center">
This public repo contains project information which will be served to display on the Boardroom Governance Portal
<br />
<a href="http://app.boardroom.info/"><strong>Browse the Portal »</strong></a>
<br />
<br />
<a href="http://boardroom.info/">Landing</a>
·
<a href="https://discord.com/invite/tgrTFg9">Discord</a>
·
<a href="https://www.boardroom.info/contact">Get In Touch</a>
2021-01-14 23:47:50 +00:00
</p>
</p>
2021-04-26 18:35:51 +00:00
## About
All project additions and edits for information uploaded, stored, and maintained on the [Boardroom Portal](https://app.boardroom.info) occur on this public Project Information repository. [These docs](https://docs.boardroom.info/integrations/getting-started) 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.
2021-04-22 11:31:36 +00:00
## Development
2021-01-14 14:04:16 +00:00
2021-04-22 11:31:36 +00:00
Clone the repo:
```sh
$ git clone git@github.com:boardroom-inc/protocol-Info.git
2021-01-14 14:04:16 +00:00
```
2021-04-22 11:31:36 +00:00
Install dependencies:
```sh
$ yarn
2021-01-15 21:35:10 +00:00
```
2021-04-22 11:31:36 +00:00
Compile the protocol info artifact to `dist`:
```sh
$ yarn build
```
2021-01-15 21:35:10 +00:00
2021-04-22 11:31:36 +00:00
Link the package:
2021-04-22 11:31:36 +00:00
```sh
$ yarn link
```
2021-01-14 14:04:16 +00:00
2021-04-22 11:31:36 +00:00
From [hub-ui](https://github.com/boardroom-inc/hub-ui) (or any other repo), use the linked package:
2021-01-14 14:04:16 +00:00
2021-04-22 11:31:36 +00:00
```sh
$ yarn link @boardroom/protocol-info
2021-01-14 14:04:16 +00:00
```
2021-04-22 11:31:36 +00:00
Run validation:
```sh
$ yarn validate
2021-01-14 14:04:16 +00:00
```
2021-04-22 11:31:36 +00:00
Cut a new release:
```sh
$ git checkout main
$ git pull
$ npx standard-version
$ yarn publish
$ git push origin main --follow-tags
```
2021-01-15 00:09:06 +00:00
2021-01-15 00:57:13 +00:00
## Contact
2021-01-15 00:09:06 +00:00
2021-01-15 00:57:13 +00:00
Please reach out in Discord with any questions!
* Boardroom Support Channel - [#❓support](https://discord.gg/CEZ8WfuK8s)