Skip to content

Latest commit

 

History

History
70 lines (43 loc) · 2.06 KB

README.md

File metadata and controls

70 lines (43 loc) · 2.06 KB
Raw

Sovereign Nature Identifier Monorepo

This is a Sovereign Nature Identifier monorepo.

What's inside?

This monorepo uses turborepo for tasks/caching and npm as a package manager. It includes the following packages/apps:

Apps and Packages

Apps:

  • @sni/contracts: Solidity contracts for Sovereign Nature Identifier built with Hardhat and OpenZeppelin
  • @sni/explorer: Explorer for Sovereign Nature Identifier built with Nuxt.js and Tailwind
  • @sni/docs: documentation generator based on Vitepress.

Packages:

  • eslint-config-*: Shared esLint configurations.
  • prettier-config: Shared prettier configuration.

Installing Dependencies

To install dependencies for whole monorepo run yarn install from the root repo dirrectory.

Build

To build all apps and packages, run the following command:

yan build

Develop

To develop all apps and packages, run the following command:

yarn dev

To develop specific package run:

npx turbo run dev --filter <PACKAGE_NAME>

For example, to develop explorer, run:

npx turbo run dev --filter @sni/explorer

Remote Caching

Turborepo can use a technique known as Remote Caching to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.

By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can create one, then enter the following commands:

npx turbo login

This will authenticate the Turborepo CLI with your Vercel account.

Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo:

npx turbo link