Skip to content

Latest commit

 

History

History
69 lines (46 loc) · 1.84 KB

README.md

File metadata and controls

69 lines (46 loc) · 1.84 KB
Raw

NFNovel Hackathon

structure

monorepo including the client (frontend and API) and evm components

<project>/
  client/ <-- [web2] client / api using next.js
  evm/ <-- [web3] contract code / tests / tasks using hardhat and ethers.js
  package.json <-- scripts to control each component or together as a system

usage

setup

in .vscode/ there are some recommended workspace extensions and settings. you can install those to get the best experience working with the codebase:

  1. on the sidebar open the extensions panel (4 squares symbol)
  2. search for @recommended
  3. install all of them
  4. find prettier-eslint in the list, click the extension and select Switch to Pre-Release Version
  5. install dependencies (from the top level) run npm install (this will install the monorepo, client and evm deps)
  6. close and reopen VSCode (you must do this or some extensions wont work)

client

the client client/tsconfig.json has aliases set up for importing:

  • @styles/*: any CSS in the client/styles/ dir
  • @evm/*: access to files in evm/ dir (artifacts, types, deployment records)

scripts

the top-level package.json contains scripts to run the client/ and evm/ scripts individually or as a system

  • individual: npm run client: -- <script> or npm run evm: -- <script>
  • together: top-level scripts (below)

run these from the project root

  1. install (installs deps for monorepo, client and evm components)
npm install
  1. run dev mode (compiles evm and runs next.js dev mode)
  • starts a local hardhat node
  • compiles and deploys the contracts (evm/tasks/dev.ts) and stores the development deployment record in evm/deployments/<Contract>.json
  • starts the client next.js dev server
npm run dev
  1. compile both for prod
npm run build
  1. run tests for evm and client
npm test