Skip to content

Commit

Permalink
Initial Commit for create-web3js-dapp
Browse files Browse the repository at this point in the history
  • Loading branch information
danforbes committed Sep 20, 2024
1 parent efb93c5 commit 8f256cf
Show file tree
Hide file tree
Showing 11 changed files with 2,300 additions and 8 deletions.
19 changes: 19 additions & 0 deletions .github/workflows/create-web3js-dapp.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: create-web3js-dapp Test & Build
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
types: [ opened, reopened, synchronize ]
jobs:
build:
name: Test & Build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 20
- run: npm i
- run: npm test
- run: npm run build
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,33 @@
# `create-web3js-dapp`

Scaffolding utility to create front-end projects with Web3.js
Scaffolding utility to create front-end projects (dApps) with Web3.js

## Usage

This utility is designed to be used via
[npx](https://docs.npmjs.com/cli/v8/commands/npx). If the `framework` or
`template` options are omitted, an interactive menu will be displayed to allow
for their selection.

```console
Usage: npx create-web3js-dapp [options]

Options:
-f, --framework <name> front-end framework (choices: "angular")
-t, --template <type> template type (choices: "minimal")
-h, --help display help for command
```

## Template Types

Two types of templates are provided. [Minimal templates](./templates/min) are
designed for users that want to build their own front-end project (dApp) without
the need to remove unnecessary boilerplate code.
[Demonstration templates](./templates/demo) are designed to showcase how Web3.js
can be used to build dApps.

## Front-End Framework

This utility supports the following front-end frameworks:

- [Angular](https://angular.dev/)
Loading

0 comments on commit 8f256cf

Please sign in to comment.