Popcorn

• Popcorn
  • Technology Used
  • Directory structure
  • Getting started with Frontend
  • Getting started with Contracts
  • Default Service Locations
  • Useful Commands
  • Contributing

Technology Used

• Next.js
• Lerna
• Yarn
• Storybook
• React styled components
• Solidity
• Hardhat
• React testing library

Directory structure

packages
├── app            [@popcorn/app]          [next.js]  
├── contracts      [@popcorn/contracts]    [solidity contracts]
├── scripts        [@popcorn/scripts]      [deploy scripts, etc]
├── utils          [@popcorn/utils]        [generic utils]
├── ui             [@popcorn/ui]           [ui components + storybook]
└── ... etc

Getting started with Frontend

1. Install packages

   • yarn install

2. Run dev (watch files and start up frontend)

   • yarn lerna run dev --parallel

3. Start storybook (optional):

   • yarn lerna run story --parallel

Getting started with Contracts

To run tests: go to packages/contracts yarn hardhat test

Deploy from packages/contracts:

1. compile: yarn hardhat compile
2. in one terminal: yarn hardhat node
3. in another terminal: yarn hardhat run --network localhost scripts/deploy.js

Default Service Locations

Service	Location
Next.js Frontend	http://localhost:3000
Storybook	run: yarn lerna run story

Useful Commands

Command	Description
yarn install	equivalent to npm install
yarn add @org/packagename	equivalent to npm install - will add to dependencies
yarn add @org/packagename -D	equivalent to npm install --save-dev - will add to devDependencies
lerna dev --parallel	run package.json "dev" script on all projects
lerna run dev --scope=@popcorn/app	run package.json "dev" script only on frontend package
lerna run story	start storybook
lerna run test --parallel	run tests

Contributing

Contributions are welcome! Please raise a pull request with your contributions.

Popcorn follows the Contributor Covenant Code of Conduct.