- Branch: kebab-case (e.g. my-branch)
- folder: kebab-case (e.g. how-it-works)
- components and views file naming: Pascal-case (e.g. Features(single word) HowItWorks(multiple words))
- general file naming: camel-case (e.g.logo.png, setupWorks.ts)
- inside of the class, variables naming should follow camel-case. (e.g myMethod)
- Run npm run lint before submitting your CR and use autofix(e.g. VS shift+command+p) to auto formatting your code
- For JavaScript using ES6 and don't include external libraries unless necessary
- For React please referring https://reactjs.org/docs/optimizing-performance.html#examples for performance optimization
- Comments are required for new class and important method. The example could be
- Inline Commenting: // begin variable listing
- Descriptive Blocks: /**
- @desc opens a modal window to display a message
- @param string $msg - the message to be displayed
- @return bool - success or failure */
- Class Comments: /**
- @desc this class will hold functions for user interaction
- examples include user_pass(), user_username(), user_age(), user_regdate()
- @author Jake Rocheleau jakerocheleau@gmail.com
- @required settings.php */
- We are using sass our our css lib
- variables.scss : $primaryColor: #BADA55;
- @import "./variables.scss";
- h1, h2 { color: $primaryColor; }
Step 1: deploy contract in local network
npx hardhat run scripts/deploy.js --network localhost
Step 2: In a terminal, start hardhat node
npx hardhat node
Step 3: Run localhost
npm run dev
https://www.figma.com/file/JMxBzjZnU8sCLkCCZ6Nyim/NFTopia?node-id=0%3A1
This project demonstrates a basic Hardhat use case. It comes with a sample contract, a test for that contract, a sample script that deploys that contract, and an example of a task implementation, which simply lists the available accounts.
Try running some of the following tasks:
npx hardhat run scripts/deploy.js --network localhost
npx hardhat accounts
npx hardhat compile
npx hardhat clean
npx hardhat test
npx hardhat node
node scripts/sample-script.js
npx hardhat help