✨eth-dapp-starter✨

Node.js + express + typescript toy project
Create eth wallet & send transaction tutoria l
ethers.js: https://docs.ethers.org/v6/

List

1. create mnemonic and master address
2. create child address
3. send transaction
4. get balance
5. get fee data
6. get nonce
7. checksum address

Prerequisites

Sign up for Infura and get an API key.
Infura: https://app.infura.io/
And get testnet Ether(sepolia)
https://www.infura.io/faucet/sepolia

Features

• nvm 0.39.7
• node v20.12.
• npm 10.5.0
• express 4.19.2
• typescript 5.4.5
• eslint 8.57.0
• prettier 3.2.5
• ethers.js 6.12.1

Install

git clone https://github.com/mine-kim/eth-dapp-starter.git
cd ./eth-dapp-starter
npm install

//create env file
vi .env.develop & .env.production 

PORT=<PORT>
ETH_NETWORK=sepolia
INFURA_API_KEY=<YOUR_API_KEY>
PRIVATE_KEY=<YOUR_WALLET_PRIVATE_KEY>

How to Run

 //development(swagger & nodemon)
 npm run dev
 
 //production(pm2)
 npm run start

How to Run (docker)

 //dev
 docker build . -t eth-dapp:latest --target=dev
 docker run -it -p 3001:3001 eth-dapp  

 //prod
 docker build . -t eth-dapp:latest --target=prod
 docker run -it -p 3002:3002 eth-dapp  

How to Run (docker-compose)

 //prod
 docker-compose up -d

SwaggerUI (build: dev)

http://localhost:3001/api-docs/

 npm run api-docs

Code Structure

├──📂 build
│  └── swagger.yaml
├──📂 dist
│  ├── common
│  ├── middleware
│  ├── router
│  ├── service
│  └── server.js
├──📂 src
│  ├──📂 common
│  │  ├── common.ts
│  │  └── type.ts
│  ├──📂 middleware
│  │  ├── commonError.ts
│  │  ├── commonLog.ts
│  │  └── responseFilter.ts
│  ├──📂 router
│  │  └── eth.ts
│  ├──📂 service
│  │  └── eth.ts
│  └── server.ts
├──📂 node_modules
│  └── .....
├──📂 swagger
│  ├── eth.yaml
│  └── openapi.yaml
├── .dockerignore
├── .env
├── .gitignore
├── .prettierrc.json
├── compose.yaml
├── Dockerfile
├── eslint.config.mjs
├── index.ts
├── package-lock.json
├── package.json
├── README.Docker.md
├── README.md
└── tsconfig.json