Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pooltogether/governance-ui


https://github.com/pooltogether/governance-ui

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README

        

# PoolTogether Governance UI

PoolTogether protocol's app for voting on governance proposals.

To run the project against a local node you can use the [pooltogether-contracts](https://github.com/pooltogether/pooltogether-contracts/tree/version-3). With those contracts you can bootstrap a local Buidler EVM instance with test data so that you can develop the app locally.

## 💾   Installation

Install dependencies:

```
yarn
```

Make sure you have `direnv` installed and copy `.envrc.example` to `.envrc`:

```
cp .envrc.example .envrc
```

Fill in your own values for `.envrc`, then run:

```
direnv allow
```

Download the localizations:

```
yarn locize:download
```

To run the local server, run:

```
yarn dev
```

## Developer

### Tools

- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
- [Locize](https://locize.io/login)

### Localization

- Be sure to download latest copy locally. This is done automatically on build.
- To add strings they must be manually added to Locize. t(key, defaultValue) isn't fully set up for `next-i18next`

### PoolTogether Repos

Some configs are shared across multiple repos. Be sure to update across all if you make changes.

#### Repos
- v4-ui
- governance-ui
- tools-ui

#### Shared
- /public/fonts
- /styles/index.css
- eslintrc.json
- .gitignore
- .nvmrc
- .prettierrc
- .prettierignore
- some .envrc
- tsconfig.json
- next-i18next.config.js