Skip to content

Commit 5da9b4c

Browse files
Eversmile12Eversmile12
committed
adds template readme
1 parent 93578de commit 5da9b4c

File tree

5 files changed

+452
-29
lines changed

5 files changed

+452
-29
lines changed

‎README.md

+1-28
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,11 @@
11
<div id="top"></div>
2-
<!--
3-
*** Thanks for checking out the Best-README-Template. If you have a suggestion
4-
*** that would make this better, please fork the repo and create a pull request
5-
*** or simply open an issue with the tag "enhancement".
6-
*** Don't forget to give the project a star!
7-
*** Thanks again! Now go create something AMAZING! :D
8-
-->
9-
10-
11-
12-
<!-- PROJECT SHIELDS -->
13-
<!--
14-
*** I'm using markdown "reference style" links for readability.
15-
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
16-
*** See the bottom of this document for the declaration of the reference variables
17-
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
18-
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
19-
-->
20-
21-
222

233
[![Contributors][contributors-shield]][contributors-url]
244
[![Forks][forks-shield]][forks-url]
255
[![Stargazers][stars-shield]][stars-url]
266
[![Issues][issues-shield]][issues-url]
277
[![MIT License][license-shield]][license-url]
288

29-
30-
319
<!-- PROJECT LOGO -->
3210
<br />
3311
<div align="center">
@@ -51,8 +29,6 @@
5129
</p>
5230
</div>
5331

54-
55-
5632
<!-- TABLE OF CONTENTS -->
5733
<details>
5834
<summary>Table of Contents</summary>
@@ -81,8 +57,6 @@
8157
</ol>
8258
</details>
8359

84-
85-
8660
<!-- ABOUT THE PROJECT -->
8761
## About The Project
8862

@@ -123,7 +97,7 @@ npm -v
12397

12498
## **Quick Start**
12599

126-
1. Create a new account on Alchemy.com.
100+
1. Create a new account on [Alchemy.com](https://alchemy.com)
127101
2. Create a new Alchemy application.
128102

129103
3. In your terminal run:
@@ -265,7 +239,6 @@ Project Link: [https://github.com/eversmile12/create-web3-dapp](https://github.c
265239

266240

267241
<!-- MARKDOWN LINKS & IMAGES -->
268-
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
269242
[contributors-shield]: https://img.shields.io/github/contributors/eversmile12/create-web3-dapp.svg?style=for-the-badge
270243
[contributors-url]: https://github.com/eversmile12/create-web3-dapp/graphs/contributors
271244
[forks-shield]: https://img.shields.io/github/forks/eversmile12/create-web3-dapp.svg?style=for-the-badge

‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "create-web3-dapp",
3-
"version": "0.0.3a",
3+
"version": "0.0.3b",
44
"private": false,
55
"scripts": {
66
"test": "echo \"Error: no test specified\" && exit 1",

‎templates/ethereum/tutorial/readme.md

+150
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
<div id="top"></div>
2+
<div align="center">
3+
<p>This project has been built using <a href="">create-web3-dapp</a></p>
4+
<p><strong>ATTENTION:</strong> create-web3-dapp is currently in beta - this application has not been tested in production and shouldn't be deployed before review.</p>
5+
</div>
6+
<!-- PROJECT LOGO -->
7+
<br />
8+
<br />
9+
<div align="center">
10+
<a href="https://github.com/eversmile12/create-web3-dapp">
11+
<img src="public/logo.svg" alt="Logo" width="100" height="100">
12+
</a>
13+
14+
<h2 align="center">Welcome to Web3</h2>
15+
16+
<p align="center">
17+
You successfully created your first Web3 Decentralized Application
18+
<br />
19+
<a href="https://docs.alchemy.com"><strong>Explore the docs »</strong></a>
20+
<br />
21+
<br />
22+
<a href="https://github.com/eversmile12/create-web3-dapp">Contribute</a>
23+
·
24+
<a href="https://github.com/eversmile12/create-web3-dapp/issues">Report Bug</a>
25+
·
26+
<a href="https://github.com/eversmile12/create-web3-dapp/issues">Request Feature</a>
27+
</p>
28+
</div>
29+
30+
31+
## **Quick Start**
32+
33+
1. Create a new account on [Alchemy.com](https://alchemy.com)
34+
2. Create a new Alchemy application.
35+
3. Navigate to the application folder
36+
```
37+
cd my-dapp
38+
```
39+
4. Run the application
40+
```sh
41+
npm run dev
42+
```
43+
5. Navigate to to <a href="localhost:3000">localhost:3000</a>
44+
45+
6. If you're using Hardhat - go to hardhat.config.js and:
46+
47+
a. Add your private key to the "accounts" property
48+
49+
b. Remove the extra quotes
50+
51+
</br>
52+
53+
**ATTENTION:** the keys stored in YOUR-PROJECT-FOLDER/.env will be accessible and visible on the front-end. It is suggested to:
54+
- Handle API Calls in the Backend through RESTFUL API
55+
- Handle API calls through server side rendering to get and render data on the backend ([getServerSideProps()](https://nextjs.org/docs/basic-features/data-fetching/get-server-side-props))
56+
57+
58+
59+
60+
<p align="right">(<a href="#top">back to top</a>)</p>
61+
62+
63+
## **Complementary Docs**
64+
65+
<ul>
66+
<li>
67+
<strong>Core:</strong>
68+
<ul>
69+
<li>NextJS - <a href="https://nextjs.org/">docs</a></li>
70+
</ul>
71+
</li>
72+
<li>
73+
<strong>Web3:</strong>
74+
<ul>
75+
<li href="https://docs.alchemy.com/reference/alchemy-sdk-quickstart">AlchemySDK - <a>docs</a></li>
76+
<li>EthersJS - <a href="https://docs.ethers.io/v5/">docs</a></li>
77+
<li>RainbowKit - <a href="https://www.rainbowkit.com/">docs</a></li>
78+
<li>PhantomWallet - <a href="https://docs.phantom.app/">docs</a></li>
79+
</ul>
80+
</li>
81+
<li>
82+
<strong>Blockchain Development Environments:</strong>
83+
<ul>
84+
<li>Hardhat - <a href="https://hardhat.org/">docs</a></li>
85+
<li>Foundry - <a href="https://book.getfoundry.sh/">docs</a></li>
86+
<li>Anchor - <a href=https://book.anchor-lang.com/">docs</a></li>
87+
</ul>
88+
</li>
89+
<li>
90+
<strong>CSS:</strong>
91+
<ul>
92+
<li>Tailwind - <a href="https://v2.tailwindcss.com/docs">docs</a></li>
93+
<li>ChakraUI - <a href="https://chakra-ui.com/getting-started">docs</a></li>
94+
</ul>
95+
</li>
96+
97+
</ul>
98+
99+
<p align="right">(<a href="#top">back to top</a>)</p>
100+
101+
102+
## **Report an Issue**
103+
104+
See the [open issues](https://github.com/eversmile12/create-web3-dapp/issues) for a full list of proposed features (and known issues).
105+
106+
<p align="right">(<a href="#top">back to top</a>)</p>
107+
108+
109+
## **FAQ**:
110+
111+
How do I substitute my Alchemy API Key?
112+
- open YOUR-PROJECT-FOLDER/.env and change your NEXT_PUBLIC_ALCHEMY_API_KEY variable
113+
114+
115+
<!-- LICENSE -->
116+
## **License**
117+
118+
Distributed under the MIT License. See `LICENSE.txt` for more information.
119+
120+
<p align="right">(<a href="#top">back to top</a>)</p>
121+
122+
123+
124+
<!-- CONTACT -->
125+
## **Contact**
126+
127+
Your Name - [@vittostack](https://twitter.com/vittostack) - [email protected]
128+
129+
Project Link: [https://github.com/eversmile12/create-web3-dapp](https://github.com/eversmile12/create-web3-dapp)
130+
131+
<p align="right">(<a href="#top">back to top</a>)</p>
132+
133+
134+
<!-- MARKDOWN LINKS & IMAGES -->
135+
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
136+
[contributors-shield]: https://img.shields.io/github/contributors/eversmile12/create-web3-dapp.svg?style=for-the-badge
137+
[contributors-url]: https://github.com/eversmile12/create-web3-dapp/graphs/contributors
138+
[forks-shield]: https://img.shields.io/github/forks/eversmile12/create-web3-dapp.svg?style=for-the-badge
139+
[forks-url]: https://github.com/eversmile12/create-web3-dapp/network/members
140+
[stars-shield]: https://img.shields.io/github/stars/eversmile12/create-web3-dapp.svg?style=for-the-badge
141+
[stars-url]: https://github.com/eversmile12/create-web3-dapp/stargazers
142+
[issues-shield]: https://img.shields.io/github/issues/eversmile12/create-web3-dapp.svg?style=for-the-badge
143+
[issues-url]: https://github.com/eversmile12/create-web3-dapp/issues
144+
[license-shield]: https://img.shields.io/github/license/eversmile12/create-web3-dapp.svg?style=for-the-badge
145+
[license-url]: https://github.com/eversmile12/create-web3-dapp/blob/master/LICENSE.txt
146+
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
147+
148+
149+
[product-screenshot]: images/screenshot.png
150+
[product-screenshot-2]: images/screenshot_2.png

‎templates/ethereum/vanilla/readme.md

+150
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
<div id="top"></div>
2+
<div align="center">
3+
<p>This project has been built using <a href="">create-web3-dapp</a></p>
4+
<p><strong>ATTENTION:</strong> create-web3-dapp is currently in beta - this application has not been tested in production and shouldn't be deployed before review.</p>
5+
</div>
6+
<!-- PROJECT LOGO -->
7+
<br />
8+
<br />
9+
<div align="center">
10+
<a href="https://github.com/eversmile12/create-web3-dapp">
11+
<img src="public/logo.svg" alt="Logo" width="100" height="100">
12+
</a>
13+
14+
<h2 align="center">Welcome to Web3</h2>
15+
16+
<p align="center">
17+
You successfully created your first Web3 Decentralized Application
18+
<br />
19+
<a href="https://docs.alchemy.com"><strong>Explore the docs »</strong></a>
20+
<br />
21+
<br />
22+
<a href="https://github.com/eversmile12/create-web3-dapp">Contribute</a>
23+
·
24+
<a href="https://github.com/eversmile12/create-web3-dapp/issues">Report Bug</a>
25+
·
26+
<a href="https://github.com/eversmile12/create-web3-dapp/issues">Request Feature</a>
27+
</p>
28+
</div>
29+
30+
31+
## **Quick Start**
32+
33+
1. Create a new account on [Alchemy.com](https://alchemy.com)
34+
2. Create a new Alchemy application.
35+
3. Navigate to the application folder
36+
```
37+
cd my-dapp
38+
```
39+
4. Run the application
40+
```sh
41+
npm run dev
42+
```
43+
5. Navigate to to <a href="localhost:3000">localhost:3000</a>
44+
45+
6. If you're using Hardhat - go to hardhat.config.js and:
46+
47+
a. Add your private key to the "accounts" property
48+
49+
b. Remove the extra quotes
50+
51+
</br>
52+
53+
**ATTENTION:** the keys stored in YOUR-PROJECT-FOLDER/.env will be accessible and visible on the front-end. It is suggested to:
54+
- Handle API Calls in the Backend through RESTFUL API
55+
- Handle API calls through server side rendering to get and render data on the backend ([getServerSideProps()](https://nextjs.org/docs/basic-features/data-fetching/get-server-side-props))
56+
57+
58+
59+
60+
<p align="right">(<a href="#top">back to top</a>)</p>
61+
62+
63+
## **Complementary Docs**
64+
65+
<ul>
66+
<li>
67+
<strong>Core:</strong>
68+
<ul>
69+
<li>NextJS - <a href="https://nextjs.org/">docs</a></li>
70+
</ul>
71+
</li>
72+
<li>
73+
<strong>Web3:</strong>
74+
<ul>
75+
<li href="https://docs.alchemy.com/reference/alchemy-sdk-quickstart">AlchemySDK - <a>docs</a></li>
76+
<li>EthersJS - <a href="https://docs.ethers.io/v5/">docs</a></li>
77+
<li>RainbowKit - <a href="https://www.rainbowkit.com/">docs</a></li>
78+
<li>PhantomWallet - <a href="https://docs.phantom.app/">docs</a></li>
79+
</ul>
80+
</li>
81+
<li>
82+
<strong>Blockchain Development Environments:</strong>
83+
<ul>
84+
<li>Hardhat - <a href="https://hardhat.org/">docs</a></li>
85+
<li>Foundry - <a href="https://book.getfoundry.sh/">docs</a></li>
86+
<li>Anchor - <a href=https://book.anchor-lang.com/">docs</a></li>
87+
</ul>
88+
</li>
89+
<li>
90+
<strong>CSS:</strong>
91+
<ul>
92+
<li>Tailwind - <a href="https://v2.tailwindcss.com/docs">docs</a></li>
93+
<li>ChakraUI - <a href="https://chakra-ui.com/getting-started">docs</a></li>
94+
</ul>
95+
</li>
96+
97+
</ul>
98+
99+
<p align="right">(<a href="#top">back to top</a>)</p>
100+
101+
102+
## **Report an Issue**
103+
104+
See the [open issues](https://github.com/eversmile12/create-web3-dapp/issues) for a full list of proposed features (and known issues).
105+
106+
<p align="right">(<a href="#top">back to top</a>)</p>
107+
108+
109+
## **FAQ**:
110+
111+
How do I substitute my Alchemy API Key?
112+
- open YOUR-PROJECT-FOLDER/.env and change your NEXT_PUBLIC_ALCHEMY_API_KEY variable
113+
114+
115+
<!-- LICENSE -->
116+
## **License**
117+
118+
Distributed under the MIT License. See `LICENSE.txt` for more information.
119+
120+
<p align="right">(<a href="#top">back to top</a>)</p>
121+
122+
123+
124+
<!-- CONTACT -->
125+
## **Contact**
126+
127+
Your Name - [@vittostack](https://twitter.com/vittostack) - [email protected]
128+
129+
Project Link: [https://github.com/eversmile12/create-web3-dapp](https://github.com/eversmile12/create-web3-dapp)
130+
131+
<p align="right">(<a href="#top">back to top</a>)</p>
132+
133+
134+
<!-- MARKDOWN LINKS & IMAGES -->
135+
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
136+
[contributors-shield]: https://img.shields.io/github/contributors/eversmile12/create-web3-dapp.svg?style=for-the-badge
137+
[contributors-url]: https://github.com/eversmile12/create-web3-dapp/graphs/contributors
138+
[forks-shield]: https://img.shields.io/github/forks/eversmile12/create-web3-dapp.svg?style=for-the-badge
139+
[forks-url]: https://github.com/eversmile12/create-web3-dapp/network/members
140+
[stars-shield]: https://img.shields.io/github/stars/eversmile12/create-web3-dapp.svg?style=for-the-badge
141+
[stars-url]: https://github.com/eversmile12/create-web3-dapp/stargazers
142+
[issues-shield]: https://img.shields.io/github/issues/eversmile12/create-web3-dapp.svg?style=for-the-badge
143+
[issues-url]: https://github.com/eversmile12/create-web3-dapp/issues
144+
[license-shield]: https://img.shields.io/github/license/eversmile12/create-web3-dapp.svg?style=for-the-badge
145+
[license-url]: https://github.com/eversmile12/create-web3-dapp/blob/master/LICENSE.txt
146+
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
147+
148+
149+
[product-screenshot]: images/screenshot.png
150+
[product-screenshot-2]: images/screenshot_2.png

0 commit comments

Comments
 (0)