D2D deal client and contracts.
- Node.js v16
- yarn CLI
- Git CLI
# clone (or fork and clone)
git clone https://github.com/dao-to-earth/d2d-deal-v1.git
cd d2d-deal-v1
# install node packages
yarn
# run client locally
yarn dev
You can check more commands in the scripts in package.json.
About .env setup, there's .env.example for reference but only for using hardhat you just have to set API keys and your private key(DEPLOYER_PRIVATE_KEY).
If you run and get errors please contract @aiinkiestism or @st2dii0.
This repo is made up of frontend(Vite + Vue3) and contract-related directories(Hardhat + hardhat-deploy).
This is just a v1 so the project structure might change.
The .github directory contains Github Actions files and dependabot script.
The abi directory contains contract ABIs that are necessary in frontend.
The contracts directory contains the deal deal protocol smart contract.
The deploy directory contains contract deployment scripts.
More information about this the usage of this in Hardhat-deploy documentation.
The public directory contains uncompiled static assets, such as images.
The src directory contains frontend-specific directories and files.
The src/assets directory contains compiled static assets, such as images and Sass files.
The src/components directory contains Vue.js components.
Components make up the different parts of your page and can be reused and imported into views directory.
The src/composables contains business logic in frontend and more heavier logic than src/helpers.
The src/helpers contains organized logic so that complex codes and library specific codes does not appear many times in the views and components.
The src/views files are exactly the same usage with pages in Nuxt.js/Next.js, which means src/views files are responsible for rendering pages.
Routing is written in src/router.ts