Skip to content

Latest commit

 

History

History

frontend

README.md

Umbra Frontend

A first party frontend for interacting with the Umbra protocol. The frontend is built with Quasar, Typescript, ethers, and a number of other technologies. It relies on umbra-js for interacting with Umbra itself.

Development

Copy the .env.example to .env and populate it with your own configuration parameters.

cp .env.example .env

The required parameters are:

BLOCKNATIVE_API_KEY - A Blocknative API key
MAINNET_RPC_URL - Network RPC URLs
POLYGON_RPC_URL
OPTIMISM_RPC_URL
GNOSIS_CHAIN_RPC_URL
ARBITRUM_ONE_RPC_URL
SEPOLIA_RPC_URL

Optional parameters are:

FORTMATIC_API_KEY - API key needed if using Fortmatic
PORTIS_API_KEY - API key needed if using Portis

Install dependencies and run the app in development mode using yarn.

yarn
yarn dev

Other commands are also available via yarn:

yarn lint # lint the codebase
yarn prettier # apply formatting rules to the codebase
yarn build # build a static version of the site for deployment
yarn clean # clear previous build artifacts
  1. Create a file called .env and populate it with the contents of .env.template
  2. Fill in the .env file with your Infura ID. You only need the Portis and Fortmatic API keys if you plan on using those wallets
  3. Install dependencies with yarn
  4. Build for development with yarn run dev

Internationalization

Usage

The app is currently available in English and Simplified Chinese. For more details on the internationalization approach and usage see Quasar I18n doc v.1.18.10 and Vue I18n v8.x doc for Vue2.

Basic usage is as follows:

  1. In the corresponding /i18n/locales/<locale>.json file add a new key and corresponding text or translation like so: "key-name" : "Sample text"
  2. Use the following templates to embed the message on the frontend:
  • Inside templates: {{ $t('key-name') }}
  • Inside attributes: :label="$t('key-name')"
  • Inside scripts, import getCurrentInstance() from 'vue' and create an instance inside a function using const vm = getCurrentInstance()!; then use vm.$i18n.tc('AccountReceiveTable.date-received')
  • Inside .ts files, import { tc } from "../boot/i18n"; and use tc('key-name').

While embedding longer texts with styles and links inside template section of Vue components, there are a few options:

  1. For texts with html tags and styles: Use Vue-i18n's HTML formatting style. E.g.,
  • Store json file key value pairs like so, adding \ in front of " to escape quotes: "key-with-html-tags": "<p>New paragraph with<span class=\"text-bold\">bold</span> text</p>"
  • Inside templates use v-html="$t('key-name') to maintain style and html tags
  • You can also use <i18n> tags as shown in step 3.
  1. For texts that contain variables: Use named formatting style. E.g.,
  • Key pairs stored as : "key-with-variables": "This is a %{varName}"
  • Inside templates use, {{ $t('key-with-variables'), { varName: JSVariableName }) }}
  1. For links or texts with html tags use <i18n> tags: Use component interpolation following Vue-i18n's list formatting style. E.g.,
  • Store key pairs like: "return-to-home": "You may now return {0} to send or receive funds", "return-home": "home"
  • Links:
<i18n path="return-to-home" tag="p" class="q-mt-md">
  <router-link class="hyperlink" :to="{ name: 'home' }">{{$t('return-home')}}</router-link>
</i18n>
  • Texts with html tags:
<i18n path="return-to-home" tag="p">
  <span class="code">Text or {{ Variable }}</span>
</i18n>
  1. Texts with multiple links or html tags: Use slot syntax. E.g.,
  • Stored key pairs like: "key-with-multiple-var": "This has multiple {{links}} or {{vars}}."
  • Inside the template:
<i18n path="key-with-multiple-var" tag="p">

  <template v-slot:links>
    <a class="hyperlink" href="https://app.umbra.cash" target="_blank" >1</a >
  </template>

  <template v-slot:vars>
    <span class="code">Text or {{ Variable }}</span>
  </template>

</i18n>

Adding a new language

If you want to add a new langauge e.g. French, you need to:

  1. Create a new json file in /i18n/locales/ and name it according to the language code listed here i.e., fr.json. You can also change your browser language in settings and console.log(locale) in the src/boot/i18n.ts file to see the language code.
  2. Copy the contents of en-US.json to your newly created <language-code>.json file and translate key values to the corresponding language of your choice.
  3. Import the json file into the src/i18n/index.ts file and export it to be used.
  4. Add the language name and language code to supportedLanguages in src/store/settings.ts.