You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[![Product Name Screen Shot][product-screenshot]](https://example.com)
98
-
99
-
Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: `github_username`, `repo_name`, `twitter_handle`, `linkedin_username`, `email_client`, `email`, `project_title`, `project_description`
100
-
101
-
<palign="right">(<ahref="#top">back to top</a>)</p>
94
+
**ATTENTION**: This project is under beta and not ready for production - using it in product is highgly discouraged without prior thorough review.
102
95
96
+
![product-screenshot]
103
97
98
+
Create and deploy a decentralized application on Ethereum, Polygon, Solana, and all major chains, in a matter of minutes.
104
99
105
-
### Built With
100
+
create-web3-dapp is an utility NPX package built on top of NextJS that allows developers to pick and choose the boilerplates of their decentralized application.
106
101
107
-
*[![Next][Next.js]][Next-url]
108
-
*[![React][React.js]][React-url]
109
-
*[![Vue][Vue.js]][Vue-url]
110
-
*[![Angular][Angular.io]][Angular-url]
111
-
*[![Svelte][Svelte.dev]][Svelte-url]
112
-
*[![Laravel][Laravel.com]][Laravel-url]
113
-
*[![Bootstrap][Bootstrap.com]][Bootstrap-url]
114
-
*[![JQuery][JQuery.com]][JQuery-url]
102
+
From the chain to use, through the wallet login system, to the React components to include and the Blockchain development environment, everything developers need to spin up their web3 dapps, bundled in an easy to use command line tool.
115
103
116
104
<palign="right">(<ahref="#top">back to top</a>)</p>
117
105
118
106
119
-
120
107
<!-- GETTING STARTED -->
121
108
## Getting Started
122
109
@@ -125,42 +112,69 @@ To get a local copy up and running follow these simple example steps.
125
112
126
113
### Prerequisites
127
114
128
-
This is an example of how to list things you need to use the software and how to install them.
129
-
* npm
130
-
```sh
131
-
npm install npm@latest -g
132
-
```
133
-
134
-
### Installation
115
+
* NodeJS
135
116
136
-
1. Get a free API Key at [https://example.com](https://example.com)
To install node go on the [official Node website](https://nodejs.org/en/download/), and download the LTS package for your Operating System.
149
118
150
-
<palign="right">(<ahref="#top">back to top</a>)</p>
119
+
To verify if NodeJS has been correctly installed on your system, open your terminal and run:
120
+
```sh
121
+
node -v
122
+
```
123
+
and
124
+
```sh
125
+
npm -v
126
+
```
151
127
152
128
129
+
### Installation
153
130
154
-
<!-- USAGE EXAMPLES -->
155
-
## Usage
131
+
1. In your terminal run
132
+
*```sh
133
+
npx create-web3-dapp
134
+
```
156
135
157
-
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
136
+
2. The first time you'll run this command, it will install the package.
158
137
159
-
_For more examples, please refer to the [Documentation](https://example.com)_
138
+
3. Now the following command again:
139
+
*```sh
140
+
npx create-web3-dapp
141
+
```
142
+
This will start the DApp creation flow.
160
143
161
144
<palign="right">(<ahref="#top">back to top</a>)</p>
162
145
163
146
147
+
## DApp Creation Flow
148
+
Once started, the create-web3-dapp wizard will ask you a series of questions to understand what to and what to not include in your dapp boilerplates.
149
+
150
+
Here's a reference to the creation flow:
151
+
152
+
1.**Insert new dapp name***(text)*
153
+
2.**select dapp chain***(options)*:
154
+
1. The user can choose between the chains supported by Alchemy including Solana
155
+
1. Because our support to Solana is currently limited, the Solana implementation has partial ROI against the EVM one.
156
+
3.**select if we want to import the template files***(true/false)*:
157
+
1. The template files contain code showcasing the Alchemy SDK capabilities (NFT API, Transfer API) through a set of NextJs components visual components.
158
+
2. If the user doesn’t install the template files, Alchemy will be only used to connect the wallet - the Alchemy SDK won’t be installed (to brainstorm)
159
+
4.**Select if we want to import a Blockchain development environment like***(options)*:
160
+
1. Hardhat (partially supported) - EVM
161
+
2. Foundry (not yet supported) - EVM
162
+
3. Anchor (not yet supported) - Solana
163
+
5.**Add Alchemy API Key:**
164
+
1. The key will be used:
165
+
1. In the front-end to connect:
166
+
1. The wallet (Solana, EVM)
167
+
2. In the Alchemy SDK if the user has installed the template files[4a](EVM)
168
+
2. In the Blockchain development environment [5](Solana, EVM)
169
+
6.**The builder will now proceed to create the project, performing the following actions:**
170
+
1. download the files from the GitHub repositories:
171
+
1.
172
+
2. Install the dependencies (Alchemy SDK, Rainbow Kit, Hardhat, etc)
173
+
3. Update the dependencies
174
+
4. Run the application
175
+
6.**The user will now be able to see the following landing page at http://localhost:3000:**
176
+
177
+
<palign="right">(<ahref="#top">back to top</a>)</p>
164
178
165
179
<!-- ROADMAP -->
166
180
## Roadmap
@@ -174,8 +188,6 @@ See the [open issues](https://github.com/github_username/repo_name/issues) for a
174
188
175
189
<palign="right">(<ahref="#top">back to top</a>)</p>
0 commit comments