Skip to content
This repository was archived by the owner on Mar 25, 2025. It is now read-only.

Commit f66166c

Browse files
committed
docs: roll v1.8.0
chore: update URL to useDapp docs docs: polish wordings in README docs: rewrite README such that it adheres to Common Changelog
1 parent b6c1076 commit f66166c

File tree

13 files changed

+105
-90
lines changed

13 files changed

+105
-90
lines changed

CHANGELOG.md

Lines changed: 93 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -5,229 +5,244 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [1.8.0] - 2022-03-19
9+
10+
### Added
11+
12+
- Add Chainlink template for both React and Vue ([#154](https://github.com/paulrberg/create-eth-app/pull/154)) (@fabioDMFerreira)
13+
- Integrate the [useDapp](https://usedapp.io/) framework (@paulrberg)
14+
15+
### Changed
16+
17+
- Refactor all contract call examples to use `useDapp` instead of the vanilla `ethers.js` library (@paulrberg)
18+
- Rename default package from "@project" to "@my-app" (@paulrberg)
19+
- Switch to simpler `@apollo/client` configuration (@paulrberg)
20+
- Update subgraph query in the Sablier v1 template (@paulrberg)
21+
- Update subgraph query in the Synthetix template (@paulrberg)
22+
- Update the subgraph specs to use the latest API versions (@paulrberg)
23+
- Use strict mode in React apps (@paulrberg)
24+
25+
### Fixed
26+
27+
- Fix the `img` tag in default vue template (@paulrberg)
28+
29+
### Removed
30+
31+
- Delete the Balancer template (both React and Vue) (@paulrberg)
32+
- Delete the Uniswap v1 template (both React and Vue) (@paulrberg)
33+
- Drop support for Node v13 and below (@paulrberg)
34+
835
## [1.7.4] - 2021-12-27
936

1037
### Fixed
1138

12-
- IPFS script in package.json in React app.
39+
- Fix the IPFS script in the `package.json` file in the React template (@paulrberg)
1340

14-
## [1.7.3] - 2021-12-27 [YANKED]
41+
## [1.7.3] - 2021-12-27
42+
43+
_This release was unpublished from npm due to a error in the `package.json` file_
1544

1645
### Fixed
1746

18-
- IPFS deploy script (see [#179](https://github.com/paulrberg/create-eth-app/issues/179))
47+
- Fix the IPFS deploy script ([#179](https://github.com/paulrberg/create-eth-app/issues/179)) (@paulrberg)
1948

2049
## [1.7.2] - 2021-11-21
2150

2251
### Fixed
2352

24-
- Include "gitignore" file in dist bundle (see [#175](https://github.com/paulrberg/create-eth-app/issues/175))
53+
- Include "gitignore" file in dist bundle ([#175](https://github.com/paulrberg/create-eth-app/issues/175)) (@paulrberg)
2554

2655
## [1.7.1] - 2021-09-20
2756

2857
### Fixed
2958

30-
- Pin version of `url-exist` dependency to 2.0.2 to fix [#162](https://github.com/paulrberg/create-eth-app/issues/162)
31-
- Types for `update-check`
59+
- Pin version of `url-exist` dependency to 2.0.2 ([#162](https://github.com/paulrberg/create-eth-app/issues/162)) (@paulrberg)
3260

3361
## [1.7.0] - 2021-09-14
3462

3563
### Added
3664

37-
- New links in the default Vue template
38-
- User info in the wallet button with ENS support via [PR #146](https://github.com/paulrberg/create-eth-app/pull/146)
65+
- Add links in the default Vue template (@paulrberg)
66+
- Add user info in the wallet button with ENS support ([#146](https://github.com/paulrberg/create-eth-app/pull/146)) (@makoto, @paulrberg)
3967

4068
### Changed
4169

42-
- Change `module` to `commonjs` in `tsconfig.json`
43-
- Rename `NETWORK_NAME` variable to `NETWORK`
44-
- Replace the "Disconnect Wallet" label with the user info
45-
- Set initial version of default React and Vue templates to "1.0.0"
46-
- Sort imports
47-
- Upgrade dependencies in default React and Vue templates
48-
- Wrap `web3Modal` instance in `useMemo` hook
49-
50-
### Fixed
51-
52-
- Parsing of GITHUB_REF when it has a prefix like `refs/heads/`
70+
- Replace the "Disconnect Wallet" label with the user info (@paulrberg)
71+
- Upgrade dependencies in default React and Vue templates (@paulrberg)
72+
- Wrap `web3Modal` instance in `useMemo` hook (@paulrberg)
5373

5474
### Removed
5575

56-
- Bespoke configuration for Solidity in `.prettierrc`
57-
- Redundant `nohoist` field in top-level `package.json`, which fixes [issue #139](https://github.com/paulrberg/create-eth-app/issues/139)
58-
- The "www" prefix from links in the default Vue template
76+
- Remove redundant `nohoist` field in top-level `package.json`
77+
([#139](https://github.com/paulrberg/create-eth-app/issues/139)) (@paulrberg)
78+
- Remove the "www" prefix from links in the default Vue template (@paulrberg)
5979

6080
## [1.6.5] - 2021-05-26
6181

6282
### Fixed
6383

64-
- Install `core.js` missing dependency in vue handlebars template, which fixes [issue #104](https://github.com/paulrberg/create-eth-app/issues/104)
84+
- Install `core.js` missing dependency in vue handlebars template
85+
([#104](https://github.com/paulrberg/create-eth-app/issues/104)) (@paulrberg)
6586

6687
## [1.6.4] - 2021-05-25
6788

6889
### Fixed
6990

70-
- Yarn workspaces command issue, as patched by @heronblade via [PR #134](https://github.com/paulrberg/create-eth-app/pull/134)
91+
- Fix the yarn workspaces command bug ([#134](https://github.com/paulrberg/create-eth-app/pull/134)) (@joshuabyler)
7192

7293
## [1.6.3] - 2021-05-14
7394

7495
### Fixed
7596

76-
- Warning caused by duplicate `body` tag, which fixes [issue #55](https://github.com/paulrberg/create-eth-app/issues/55)
97+
- Fix the warning caused by duplicate `body` tags ([#55](https://github.com/paulrberg/create-eth-app/issues/55)) (@paulrberg)
7798

7899
## [1.6.2] - 2020-12-20
79100

80101
### Fixed
81102

82-
- The infinite re-render bug, as reported and patched by @gasolin with [PR #92](https://github.com/paulrberg/create-eth-app/pull/92)
103+
- Fix the infinite re-render bug ([#92](https://github.com/paulrberg/create-eth-app/pull/92)) (@gasolin)
83104

84105
## [1.6.1] - 2020-11-20
85106

86107
### Added
87108

88-
- Balancer template, as per [PR #98](https://github.com/PaulRBerg/create-eth-app/pull/98)
89-
- mStable template, as per [PR #97](https://github.com/PaulRBerg/create-eth-app/pull/97)
90-
- [Internal] Comprehensive unit and integration tests with good coverage of the repo, as per [PR #86](https://github.com/PaulRBerg/create-eth-app/pull/86)
91-
- [Internal] New [env.ts](https://github.com/PaulRBerg/create-eth-app/tree/v1.6.1/src/helpers/env.ts) helper that deals with environment variable management
109+
- Add Balancer template ([#98](https://github.com/paulrberg/create-eth-app/pull/98)) (@TomAFrench)
110+
- Add mStable template ([#96](https://github.com/paulrberg/create-eth-app/pull/96)) (@paulrberg)
92111

93112
### Changed
94113

95-
- Refactor web3Modal code as a React Hook, [courtesy](https://github.com/PaulRBerg/create-eth-app/pull/79) of @gasolin
96-
- Rename "dist" to "build" in Vue.js templates, as per [PR #77](https://github.com/PaulRBerg/create-eth-app/pull/77)
97-
- Strict version tags for the download urls, as per [PR #76](https://github.com/PaulRBerg/create-eth-app/pull/76)
98-
- Upgrade dependencies, both ours and the react and vue template ones
99-
- [Internal] Rename many of the helpers, e.g. `isFolderEmpty` to `directories`
100-
- [Internal] Upgrade to TypeScript v4
101-
- [Internal] Use ESlint instead of TSLint and fix [issue #74](https://github.com/PaulRBerg/create-eth-app/issues/74)
102-
- [Internal] Use @vercel/ncc instead of @zeit/ncc and fix [issue #21](https://github.com/PaulRBerg/create-eth-app/issues/21)
114+
- Refactor web3Modal code as a React Hook ([#79](https://github.com/paulrberg/create-eth-app/pull/79)) (@gasolin)
115+
- Rename "dist" to "build" in Vue.js templates ([#77](https://github.com/paulrberg/create-eth-app/pull/77)) (@TomAFrench)
116+
- Strict version tags for the download urls ([#76](https://github.com/paulrberg/create-eth-app/pull/76)) (@paulrberg)
117+
- Upgrade dependencies (@paulrberg)
103118

104119
### Fixed
105120

106-
- Duplicate comment about Infura, [courtesy](https://github.com/PaulRBerg/create-eth-app/pull/84) of @gasolin
107-
- [Internal] [Issue #56](https://github.com/PaulRBerg/create-eth-app/issues/56) by setting up CI on GitHub Actions
121+
- Remove duplicate comment about Infura ([#84](https://github.com/paulrberg/create-eth-app/pull/84) (@gasolin)
108122

109123
## [1.5.0] - 2020-09-14
110124

111125
### Added
112126

113-
- Simple integration of web3Modal to React templates, as per [PR #63](https://github.com/PaulRBerg/create-eth-app/pull/63)
127+
- Integrate `web3-modal` in React templates ([#63](https://github.com/paulrberg/create-eth-app/pull/63)) (@TomAFrench)
114128

115129
## [1.4.1] - 2020-09-03
116130

117131
### Fixed
118132

119-
- Branch name set back to "develop" after being erroneously set to "staging" when v1.4.0 was shipped
133+
- Set branch name back to "develop" (@paulrberg)
120134

121135
## [1.4.0] - 2020-08-23
122136

123137
### Added
124138

125-
- New IPFS deployment script allowing publishing of apps with `yarn ipfs`, as per [PR #58](https://github.com/PaulRBerg/create-eth-app/pull/58)
139+
- Add new IPFS deployment script ([#58](https://github.com/paulrberg/create-eth-app/pull/58)) (@TomAFrench)
126140

127141
### Changed
128142

129-
- Update React template component styling to use [styled-components](https://styled-components.com/), as per [PR #51](https://github.com/PaulRBerg/create-eth-app/pull/51)
130-
- Update the location of subgraph query definitions, as per [PR #50](https://github.com/PaulRBerg/create-eth-app/pull/50)
131-
- Update the `@uniswap/sdk` version to v3.0.2, as per [PR #52](https://github.com/PaulRBerg/create-eth-app/pull/52)
143+
- Update React template component styling to use `styled-components`
144+
([#51](https://github.com/paulrberg/create-eth-app/pull/51)) (@TomAFrench)
145+
- Update the location of subgraph query definitions ([#50](https://github.com/paulrberg/create-eth-app/pull/50)) (@TomAFrench)
146+
- Update to `@uniswap/sdk`v3.0.2 ([#52](https://github.com/paulrberg/create-eth-app/pull/52)) (@TomAFrench)
132147

133148
### Fixed
134149

135-
- Incorrect package names in certain templates' READMEs fixed, as per [PR #54](https://github.com/PaulRBerg/create-eth-app/pull/54)
150+
- Fix incorrect package names in READMEs ([#54](https://github.com/paulrberg/create-eth-app/pull/54)) (@TomAFrench)
136151

137152
## [1.3.1] - 2020-07-30
138153

139154
### Changed
140155

141-
- The Compound template, as per [issue #39](https://github.com/PaulRBerg/create-eth-app/issues/39)
156+
- Update the Compound template ([#39](https://github.com/paulrberg/create-eth-app/issues/39)) (@paulrberg)
142157

143158
### Fixed
144159

145-
- Bug in Aave template, as per [PR #46](https://github.com/PaulRBerg/create-eth-app/pull/46)
146-
- Incorrect paths in .gitignore, as per [5eabf30](https://github.com/PaulRBerg/create-eth-app/commit/5eabf30a664b68b66b28754e542b791b598249bd)
160+
- Bug in Aave template ([#46](https://github.com/paulrberg/create-eth-app/pull/46)) (@paulrberg)
161+
- Incorrect paths in .gitignore ([#43](https://github.com/paulrberg/create-eth-app/pull/43)) (@TomAFrench)
147162

148163
### Removed
149164

150-
- TypeScript as a dev dependency in the React app, as per [issue #41](https://github.com/PaulRBerg/create-eth-app/issues/41)
165+
- Remove dependency on TypeScript from React template ([#41](https://github.com/paulrberg/create-eth-app/issues/41)) (@paulrberg)
151166

152167
## [1.3.0] - 2020-07-19
153168

154169
### Added
155170

156-
- Four DeFi templates: Kyber, Maker, Synthetix and Uniswap V2, settable as values for the `--template` command-line argument
171+
- Add four new DeFi templates: Kyber, Maker, Synthetix and Uniswap V2 (@paulrberg)
157172

158173
### Changed
159174

160-
- Refactor the template system, which is now a "template of templates" built with
161-
[handlebars.js](https://handlebarsjs.com/) as per [issue #30](https://github.com/PaulRBerg/create-eth-app/issues/30)
162-
- Make Uniswap v2 the default template when passing `--template uniswap`
163-
- Upgrade to ethers v5
164-
- Use only `dependencies` in the frontend app package instead of both `dependencies` and `devDependencies`
165-
- (Contributors) Define the branch whence the templates are pulled as an editable property
175+
- Refactor the template system with Handlebars ([#30](https://github.com/paulrberg/create-eth-app/issues/30)) (@paulrberg)
176+
- Make Uniswap v2 the default template when passing `--template uniswap` (@paulrberg)
177+
- Upgrade to ethers v5 (@paulrberg)
178+
- Use only `dependencies` in the frontend app package instead of both `dependencies` and `devDependencies` (@paulrberg)
179+
- (Contributors) Define the branch whence the templates are pulled as an editable property (@paulrberg)
166180

167181
### Fixed
168182

169-
- Add missing local dependencies, as per [issue #36](https://github.com/PaulRBerg/create-eth-app/issues/36)
183+
- Add missing local dependencies ([#36](https://github.com/paulrberg/create-eth-app/issues/36)) (@paulrberg)
170184

171185
### Removed
172186

173-
- The duplicated React and Vue.js code from the `templates` folder
187+
- Remove the duplicated React and Vue.js code from the `templates` directory (@paulrberg)
174188

175189
## [1.2.0] - 2020-05-09
176190

177191
### Added
178192

179-
- New command-line argument: `--framework`
180-
- Vue.js templates for the default template and all other DeFi templates
193+
- Add Vue.js templates for the default template and all other DeFi templates (@paulrberg)
194+
- Implement new command-line argument: `--framework` (@paulrberg)
181195

182196
### Changed
183197

184-
- Bring [the default template](https://github.com/paulrberg/cea-template) into this repository
185-
- Move the `isUrlOk` function from `templates.js` to its bespoke file
186-
- Rename the Sablier template from "sablier" to "sablier-v1"
187-
- Reorganise the React templates under a new directory called "react"
188-
- Swap the Create React App labels with Create Eth App labels in the default template
198+
- Bring [the default template](https://github.com/paulrberg/cea-template) into this repository (@paulrberg)
199+
- Move the `isUrlOk` function from `templates.js` to its bespoke file (@paulrberg)
200+
- Rename the Sablier template from "sablier" to "sablier-v1" (@paulrberg)
201+
- Reorganize the React templates under a new directory called "react" (@paulrberg)
202+
- Swap the Create React App labels with Create Eth App labels in the default template (@paulrberg)
189203

190204
### Removed
191205

192-
- The `downloadAndExtractTemplate` function in `templates.js`
193-
- The "packages" section in the [README](/README.md)
206+
- The `downloadAndExtractTemplate` function in `templates.js` (@paulrberg)
207+
- The "packages" section in the [README](/README.md) (@paulrberg)
194208

195209
## [1.1.1] - 2020-05-09
196210

197211
### Added
198212

199-
- This CHANGELOG file
213+
- Add a CHANGELOG file (@paulrberg)
200214

201215
### Changed
202216

203-
- New screencast in README, courtesy of [@TomAFrench](https://github.com/TomAFrench)
217+
- New screencast in README ([#19](https://github.com/paulrberg/create-eth-app/pull/19)) (@TomAFrench)
204218

205219
### Fixed
206220

207-
- The workspaces error on Windows, thanks to [@rnbrady](https://github.com/rnbrady)
221+
- Fix the yarn workspaces error on Windows ([#20](https://github.com/paulrberg/create-eth-app/pull/20)) (Richard Brady)
208222

209223
## [1.1.0] - 2020-03-10
210224

211225
### Added
212226

213-
- New command-line argument: `--template`
214-
- Four DeFi templates to use with the argument above: Aave, Compound, Sablier and Uniswap v1
227+
- Add four DeFi templates to use with the argument above: Aave, Compound, Sablier and Uniswap v1 (@paulrberg)
228+
- Implement command-line argument: `--template` (@paulrberg)
215229

216230
### Changed
217231

218-
- Set `module` to `ES2015` and `skipLibCheck` to `false` in the root `tsconfig.json`
232+
- Set `module` to `ES2015` and `skipLibCheck` to `false` in the root `tsconfig.json` (@paulrberg)
219233

220234
### Fixed
221235

222-
- Fix minor typos in README
236+
- Fix minor typos in README ([#10](https://github.com/paulrberg/create-eth-app/pull/10)) (Andrew Coathup, Paul Razvan Berg)
223237

224238
## [1.0.0] - 2020-02-15
225239

226240
### Added
227241

228-
- Initial release of the tool
229-
- The default template
242+
- Initial release of the tool (@paulrberg)
243+
- The default template (@paulrberg)
230244

245+
[1.8.0]: https://github.com/paulrberg/create-eth-app/compare/v1.7.4...v1.8.0
231246
[1.7.4]: https://github.com/paulrberg/create-eth-app/compare/v1.7.3...v1.7.4
232247
[1.7.3]: https://github.com/paulrberg/create-eth-app/compare/v1.7.2...v1.7.3
233248
[1.7.2]: https://github.com/paulrberg/create-eth-app/compare/v1.7.1...v1.7.2

handlebars/react/packages/react-app/src/App.js.hbs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ function App() {
7878
<Link href="https://reactjs.org">
7979
Learn React
8080
</Link>
81-
<Link href="https://usedapp.readthedocs.io/">Learn useDapp</Link>
81+
<Link href="https://usedapp.io/">Learn useDapp</Link>
8282
<Link href="{{ learn.url }}">Learn {{ learn.name }}</Link>
8383
</Body>
8484
</Container>

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "create-eth-app",
33
"description": "Create Ethereum-powered apps with one command",
4-
"version": "1.7.4",
4+
"version": "1.8.0",
55
"bin": "./dist/index.js",
66
"bugs": {
77
"url": "https://github.com/paulrberg/create-eth-app/issues"

templates/react/aave/packages/react-app/src/App.js.ctx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"contractCall": [
3-
"// Read more about useDapp on https://usedapp.readthedocs.io/",
3+
"// Read more about useDapp on https://usedapp.io/",
44
"const { error: contractCallError, value: tokenBalance } =",
55
" useCall({",
66
" contract: new Contract(addresses[MAINNET_ID].tokens.aDAI, abis.aToken),",

templates/react/chainlink/packages/react-app/src/App.js.ctx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"contractCall": [
3-
"// Read more about useDapp on https://usedapp.readthedocs.io/",
3+
"// Read more about useDapp on https://usedapp.io/",
44
"const { error: contractCallError, value: price } =",
55
" useCall({",
66
" contract: new Contract(addresses[MAINNET_ID].ETHUSD, AggregatorV3InterfaceABI),",

templates/react/compound/packages/react-app/src/App.js.ctx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"contractCall": [
3-
"// Read more about useDapp on https://usedapp.readthedocs.io/",
3+
"// Read more about useDapp on https://usedapp.io/",
44
"const { error: contractCallError, value: tokenBalance } =",
55
" useCall({",
66
" contract: new Contract(addresses[MAINNET_ID].tokens.cDAI, abis.tokens.cDAI),",

templates/react/default/packages/react-app/src/App.js.ctx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"contractCall": [
3-
"// Read more about useDapp on https://usedapp.readthedocs.io/",
3+
"// Read more about useDapp on https://usedapp.io/",
44
"const { error: contractCallError, value: tokenBalance } =",
55
" useCall({",
66
" contract: new Contract(addresses.ceaErc20, abis.erc20),",

templates/react/kyber/packages/react-app/src/App.js.ctx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"contractCall": [
3-
"// Read more about useDapp on https://usedapp.readthedocs.io/",
3+
"// Read more about useDapp on https://usedapp.io/",
44
"const { error: contractCallError, value: exchangeRate } =",
55
" useCall({",
66
" contract: new Contract(addresses[MAINNET_ID].kyberNetworkProxyV2, abis.kyberNetworkProxyV2),",

templates/react/maker/packages/react-app/src/App.js.ctx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"contractCall": [
3-
"// Read more about useDapp on https://usedapp.readthedocs.io/",
3+
"// Read more about useDapp on https://usedapp.io/",
44
"// ilk = collateral in Maker jargon. The code below pulls data for the ETH collateral.",
55
"const { error: contractCallError, value: ilk } =",
66
" useCall({",

templates/react/mstable/packages/react-app/src/App.js.ctx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"contractCall": [
3-
"// Read more about useDapp on https://usedapp.readthedocs.io/",
3+
"// Read more about useDapp on https://usedapp.io/",
44
"const { error: contractCallError, value: mUsdTotalSupply } =",
55
" useCall({",
66
" contract:new Contract(addresses[MAINNET_ID].tokens.mUSD, abis.mAsset),",

0 commit comments

Comments
 (0)