Skip to content

Commit a34f9c9

Browse files
author
Dan Forbes
authored
Initial Commit for create-web3js-dapp (#5)
1 parent db5ed3f commit a34f9c9

File tree

11 files changed

+2300
-8
lines changed

11 files changed

+2300
-8
lines changed
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: create-web3js-dapp Test & Build
2+
on:
3+
push:
4+
branches: [ main ]
5+
pull_request:
6+
branches: [ main ]
7+
types: [ opened, reopened, synchronize ]
8+
jobs:
9+
build:
10+
name: Test & Build
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- uses: actions/setup-node@v4
15+
with:
16+
node-version: 20
17+
- run: npm i
18+
- run: npm test
19+
- run: npm run build

README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,33 @@
11
# `create-web3js-dapp`
22

3-
Scaffolding utility to create front-end projects with Web3.js
3+
Scaffolding utility to create front-end projects (dApps) with Web3.js
4+
5+
## Usage
6+
7+
This utility is designed to be used via
8+
[npx](https://docs.npmjs.com/cli/v8/commands/npx). If the `framework` or
9+
`template` options are omitted, an interactive menu will be displayed to allow
10+
for their selection.
11+
12+
```console
13+
Usage: npx create-web3js-dapp [options]
14+
15+
Options:
16+
-f, --framework <name> front-end framework (choices: "angular")
17+
-t, --template <type> template type (choices: "minimal")
18+
-h, --help display help for command
19+
```
20+
21+
## Template Types
22+
23+
Two types of templates are provided. [Minimal templates](./templates/min) are
24+
designed for users that want to build their own front-end project (dApp) without
25+
the need to remove unnecessary boilerplate code.
26+
[Demonstration templates](./templates/demo) are designed to showcase how Web3.js
27+
can be used to build dApps.
28+
29+
## Front-End Framework
30+
31+
This utility supports the following front-end frameworks:
32+
33+
- [Angular](https://angular.dev/)

0 commit comments

Comments
 (0)