README.md

Frontend monorepo for Element Protocol

This repo contains frontend packages and applications for the Element protocol and related projects.

Required node version

• Node 14.19.1
• Vercel only supports node 12.x and 14.x as of this writing.
• This repo contains an .nvmrc, so you can just run nvm use from the top-level.

Required yarn version

• **yarn 1.22.18 **
• Vercel supports Yarn 1, see: https://vercel.com/support/articles/does-vercel-support-yarn-2
• Run: npm install -g [email protected]

Development

1. Clone the repo: git clone [email protected]:delvtech/frontend-monorepo.git
2. Run yarn at the top-level to install all packages across every workspace

Installing new packages

Here are a few examples of how to install packages in this repo:

# Install prettier for the top-level package.json, useful for tooling that
# runs against the entire monorepo
yarn add prettier

# Install lodash for the packages/base workspace.
# Note: specify the workspace by the name in its `package.json`, ie: `base` not `packages/base`
yarn workspace @elementfi/base add lodash

Installing a workspace package

To install a project in the packages/ directory as a dependency, copy it directly into your package.json like this, then run yarn.

{
  "dependencies": {
    // Name comes from packages/core/package.json
    "@elementfi/core": "*"
  }
}

Running workspace scripts

To run scripts in workspaces, use the following command:

yarn workspace <workspace-name> <package.json script>

Example

yarn workspace elf-council-frontend start