Skip to content

Commit ef1abf2

Browse files
danforbesjdevcs
danforbes
and
jdevcs
authored
Project Structure (#1)
* Project Structure * Update package.json Co-authored-by: Junaid <86780488+jdevcs@users.noreply.github.com> --------- Co-authored-by: Junaid <86780488+jdevcs@users.noreply.github.com>
1 parent 8652234 commit ef1abf2

File tree

7 files changed

+131
-1
lines changed

7 files changed

+131
-1
lines changed

‎.gitignore‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# General
2+
.DS_Store
3+
*.swp
4+
*.orig
5+
6+
# Secrets
7+
.secrets.json
8+
9+
# Logs
10+
logs
11+
*.log
12+
npm-debug.log*
13+
14+
# Directory for instrumented libs generated by jscoverage/JSCover
15+
lib-cov
16+
17+
# nyc test coverage
18+
.nyc_output
19+
20+
# Dependency directories
21+
node_modules
22+
23+
# Optional npm cache directory
24+
.npm
25+
.coverage
26+
.tool-versions
27+
28+
# IDE directories
29+
.idea
30+
tmp
31+
32+
# Distribution directory
33+
.vscode
34+
lib/
35+
dist/
36+
tsconfig.tsbuildinfo
37+
38+
tmp/
39+
40+
# Incubed (in3) nodelist
41+
packages/web3/.in3/
42+
43+
# benchmark results
44+
benchmark-data.txt
45+
46+
.eslintcache
47+
48+
.history
49+
50+
.env
51+
52+
# Hardhat files
53+
/cache
54+
/artifacts
55+
56+
# TypeChain files
57+
/typechain
58+
/typechain-types
59+
60+
# solidity-coverage files
61+
/coverage
62+
/coverage.json
63+
64+
# Hardhat Ignition default folder for deployments against a local node
65+
ignition/deployments/chain-31337
66+

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 create-web3js-dapp
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
# create-web3js-dapp
1+
# `create-web3js-dapp`
2+
3+
Scaffolding utility to create front-end projects with Web3.js

‎package.json‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"name": "create-web3js-dapp",
3+
"version": "0.1.0",
4+
"description": "Scaffolding utility to create front-end projects with Web3.js",
5+
"main": "src/index.js",
6+
"type": "module",
7+
"engines": {
8+
"node": ">=20"
9+
},
10+
"bin": {
11+
"create-web3js-dapp": "src/index.js"
12+
},
13+
"contributors": [
14+
"ChainSafe <info@chainsafe.io>"
15+
],
16+
"license": "MIT"
17+
}

‎src/index.js‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#!/usr/bin/env node
2+
3+
console.log("Hello, create-web3-dapp!");

‎templates/demo/README‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Web3.js Demo dApp Templates
2+
3+
The projects in this folder demonstrate using Web3.js with various front-end
4+
frameworks. They include Web3.js as a dependency and expose a
5+
[Web3](https://docs.web3js.org/api/web3/class/Web3) instance that is created
6+
with an
7+
[injected provider](https://docs.web3js.org/guides/web3_providers_guide/#injected-provider).
8+
These templates are designed to showcase how Web3.js can be used to build dApps.
9+
Refer to the [minimal templates](../min) for simple starter projects with less
10+
boilerplate.

‎templates/min/README‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Web3.js Minimal dApp Templates
2+
3+
The projects in this folder are minimal templates for using Web3.js with various
4+
front-end frameworks. They include Web3.js as a dependency and expose a
5+
[Web3](https://docs.web3js.org/api/web3/class/Web3) instance that is created
6+
with an
7+
[injected provider](https://docs.web3js.org/guides/web3_providers_guide/#injected-provider).
8+
These templates are designed for users that want to build their own dApp without
9+
the need to remove unnecessary boilerplate code. Refer to the
10+
[demo templates](../demo) for fully featured examples of using Web3.js from the
11+
browser.

0 commit comments

Comments
 (0)