Skip to content

Latest commit

 

History

History
152 lines (99 loc) · 4.81 KB

README.md

File metadata and controls

152 lines (99 loc) · 4.81 KB
Raw

Nouns Builder monorepo

This is Nouns Builder front-end mono-repo. You can find Nouns Builder deployed on:

For an introduction to Nouns Builder and its concept, you can find further documentation here. You can also find Nouns Protocol here.

Apps and packages in this repository include:

apps

  • web: Nouns Builder front-end
  • subgraph: Nouns Builder subgraph

packages

  • blocklist: Package to check for sanctioned wallet addresses
  • analytics: Shareable analytics package
  • zoralabs-zord: Shareable ui components
  • eslint-config-custom: eslint configurations (includes eslint-config-next and eslint-config-prettier)
  • tsconfig: tsconfig.jsons used throughout the monorepo
  • ipfs-service: api to for image uploads to ipfs

Quickstart

Get up and running

  1. Clone this repo locally

  2. Install pnpm

  3. Add the required environment variables

  4. Install dependencies across all apps and packages

pnpm i
  1. Once environment variables are defined, you can run the app in dev mode
pnpm dev

Linting and formatting

Note: linting and prettier formatting are automatically run on pre-push hooks

To lint:

pnpm run lint

To format:

pnpm run format

To run type checks:

pnpm run type-check

To create and run a production build

> pnpm run build
> pnpm run start

Environment variables

This app has several third party api keys that you need in order to run Builder:

  • alchemy as the main rpc node provider in addition to mainnet forks for testing
  • tenderly in order to simulate transactions
  • etherscan to dyanamically fetch abis

We ask that you supply your own secrets locally for running in development environment. Non-secret environment variables are already included in the .env files in this repo.

Add the following variables to .env.local within this root directory (needed to run tests against a local anvil node):

#alchemy
PRIVATE_ALCHEMY_ID=<ALCHEMY_API_KEY>
ANVIL_FORK_URL=https://eth-mainnet.alchemyapi.io/v2/$PRIVATE_ALCHEMY_ID
ANVIL_BLOCK_NUMBER=8305745

Add the following variables to apps/web/.env.local:

#alchemy
NEXT_PUBLIC_TENDERLY_RPC_KEY=<ALCHEMY_API_KEY>


#tenderly
TENDERLY_ACCESS_KEY=<API_KEY>
TENDERLY_PROJECT=<PROJECT_NAME>
TENDERLY_USER=<ACCOUNT_NAME>

#etherscan (optional to run locally, this is for dynamically fetching abis in the custom transaction builder)
ETHERSCAN_API_KEY=<ETHERSCAN_API_KEY>

#optional zora api key
NEXT_PUBLIC_ZORA_API_KEY=

Running tests

Note: to run tests you need to install anvil.

Once anvil is installed, you can now locally run anvil (from the root directory in the monorepo) in a separate terminal session to start a local ethereum node: pnpm run anvil

Now you can run the tests in a separate terminal session: pnpm run test

You can also run the tests in watchmode, which will react to any source code or test files changing. To do that, run: pnpm run test:watch

Deployments

Client

The Nouns Builder client is deployed on Vercel. Any pull requests will trigger a new preview deployment providing you with an environment to test out and preview changes.

Subgraph

The Nouns Builder subgraph is deployed for the following networks:

Contributions

Please refer to our contributions guideline on how best to contribute.

Questions?

Feel free to reach out to us via twitter, discord, or via email at [email protected]