dbeal-eth / js-monorepo

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Synthetix JS - Monorepo

main

Packages

Package Status Description
@synthetixio/contracts-interface npm version Synthetix Contracts Interface
@synthetixio/providers npm version Synthetix Providers for Layer 1 & 2
@synthetixio/optimism-networks npm version Network utility for Optimism Layer 2
@synthetixio/transaction-notifier npm version Transaction utility for Layer 1 & 2

Developer Instructions

This repo uses lerna to manage multiple packages in the same repo. To prepare the repository for use, run:

npm install
npm run bootstrap

This will install all npm dependencies, wire dependencies between packages in this repo, and allow for you to build projects.

Building

If you make a change and want to generate the library JS code, run:

npm run build

This will ensure all projects are fully built in topological order. You are also free to run script NPM commands from individual repositories if necessary or desired.

Publishing

lerna is specially designed to handle package updates. If you want to push a new release for one or more packages in this repo, run:

lerna publish

Lerna will automatically detect changes for packages, and offer to increment the version number and push an NPM release as appropriate. Any dependant modules will be kept in sync as well.

About


Languages

Language:TypeScript 97.7%Language:JavaScript 1.7%Language:HTML 0.6%