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:

INFURA_ID - A valid Infura App Identifier
BLOCKNATIVE_API_KEY - A Blocknative API key

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