create-near-app 6.0.1-beta.0 → 6.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -17
- package/package.json +2 -2
- package/templates/contracts/ts/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# Create NEAR App
|
|
2
|
-
|
|
2
|
+
|
|
3
3
|
[](https://gitpod.io/#https://github.com/nearprotocol/create-near-app)
|
|
4
4
|
|
|
5
5
|
Quickly build apps backed by the [NEAR](https://near.org) blockchain
|
|
@@ -7,7 +7,7 @@ Quickly build apps backed by the [NEAR](https://near.org) blockchain
|
|
|
7
7
|
|
|
8
8
|
## Prerequisites
|
|
9
9
|
|
|
10
|
-
Make sure you have a [current version of Node.js](https://nodejs.org/en/about/releases/) installed – we are targeting versions `16
|
|
10
|
+
Make sure you have a [current version of Node.js](https://nodejs.org/en/about/releases/) installed – we are targeting versions `16+` for JS contracts and `18+` for frontend/gateways.
|
|
11
11
|
|
|
12
12
|
Read about other [prerequisites](https://docs.near.org/develop/prerequisites) in our docs.
|
|
13
13
|
|
|
@@ -15,36 +15,45 @@ Read about other [prerequisites](https://docs.near.org/develop/prerequisites) in
|
|
|
15
15
|
|
|
16
16
|
To create a new NEAR project run this and follow interactive prompts:
|
|
17
17
|
|
|
18
|
-
npx create-near-app
|
|
19
|
-
|
|
20
|
-
> If you've previously installed `create-near-app` globally via `npm install -g create-near-app`, please uninstall the package using `npm uninstall -g create-near-app` to ensure that `npx` always uses the latest version.
|
|
18
|
+
npx create-near-app@latest
|
|
21
19
|
|
|
22
20
|
Follow the instructions in the README.md in the project you just created! 🚀
|
|
23
21
|
|
|
22
|
+
|
|
23
|
+
### Contracts
|
|
24
24
|
You can create contracts written in:
|
|
25
|
+
- `Javascript`
|
|
26
|
+
- `Rust`
|
|
25
27
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
28
|
+
:::
|
|
29
|
+
We strongly recommend you to follow our [smart contract quickstart](https://docs.near.org/develop/contracts/welcome) if you are new to NEAR contracts.
|
|
30
|
+
:::
|
|
29
31
|
|
|
30
|
-
You can
|
|
32
|
+
For testing we use a sandboxed environment. You can write the tests in JavaScript or Rust.
|
|
33
|
+
|
|
34
|
+
### WebApps
|
|
35
|
+
|
|
36
|
+
You can create a web application in:
|
|
31
37
|
|
|
32
38
|
- [React](https://reactjs.org/)
|
|
33
39
|
- Vanilla JavaScript
|
|
34
40
|
|
|
35
|
-
|
|
36
|
-
|
|
41
|
+
:::
|
|
42
|
+
We strongly recommend you to follow our [web app quickstart](https://docs.near.org/develop/integrate/welcome) if you are new to NEAR WebApps.
|
|
43
|
+
:::
|
|
44
|
+
|
|
45
|
+
> Consider using `pnpm` to handle the webapps, since it is much faster than `npm` and `yarn`.
|
|
37
46
|
|
|
38
|
-
|
|
47
|
+
## Using CLI arguments to run `create-near-app`
|
|
39
48
|
|
|
40
49
|
This CLI supports arguments to skip interactive prompts:
|
|
41
50
|
|
|
42
51
|
```shell
|
|
43
52
|
npx create-near-app
|
|
44
53
|
<project-name>
|
|
45
|
-
--
|
|
46
|
-
--
|
|
47
|
-
--tests js|
|
|
54
|
+
--frontend next|vanilla|none
|
|
55
|
+
--contract js|rs|none
|
|
56
|
+
--tests js|rs|none
|
|
48
57
|
--install
|
|
49
58
|
```
|
|
50
59
|
|
|
@@ -62,8 +71,8 @@ Check out our [documentation](https://docs.near.org) or chat with us on [Discord
|
|
|
62
71
|
To make changes to `create-near-app` itself:
|
|
63
72
|
|
|
64
73
|
* clone the repository (Windows users, [use `git clone -c core.symlinks=true`](https://stackoverflow.com/a/42137273/249801))
|
|
65
|
-
* in your terminal, enter one of the folders inside `templates`, such as `templates/vanilla`
|
|
66
|
-
* now you can run `
|
|
74
|
+
* in your terminal, enter one of the folders inside `templates`, such as `templates/frontend/vanilla`
|
|
75
|
+
* now you can run `pnpm install` to install dependencies and `pnpm run dev` to run the local development server, just like you can in a new app created with `create-near-app`
|
|
67
76
|
|
|
68
77
|
|
|
69
78
|
#### About commit messages
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-near-app",
|
|
3
|
-
"version": "6.0.
|
|
3
|
+
"version": "6.0.2",
|
|
4
4
|
"description": "Quickly scaffold your dApp on NEAR Blockchain",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"engines": {
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
"chalk": "^4.1.2",
|
|
28
28
|
"commander": "^11.0.0",
|
|
29
29
|
"cross-spawn": "^7.0.3",
|
|
30
|
-
"mixpanel": "^0.
|
|
30
|
+
"mixpanel": "^0.18.0",
|
|
31
31
|
"ncp": "^2.0.0",
|
|
32
32
|
"prompts": "^2.4.2",
|
|
33
33
|
"semver": "^7.5.3"
|
|
@@ -9,8 +9,8 @@
|
|
|
9
9
|
"scripts": {
|
|
10
10
|
"build": "near-sdk-js build src/contract.ts build/hello_near.wasm",
|
|
11
11
|
"deploy": "near dev-deploy --wasmFile build/hello_near.wasm",
|
|
12
|
-
"test": "cd sandbox-ts && $npm_execpath run test --
|
|
13
|
-
"postinstall": "cd sandbox-ts && $npm_execpath
|
|
12
|
+
"test": "$npm_execpath run build && cd sandbox-ts && $npm_execpath run test -- ../build/hello_near.wasm",
|
|
13
|
+
"postinstall": "cd sandbox-ts && $npm_execpath install"
|
|
14
14
|
},
|
|
15
15
|
"dependencies": {
|
|
16
16
|
"near-cli": "^3.4.2",
|