Skip to content

Commit d597ca5

Browse files
authored
Merge pull request #12 from Quantum3-Labs/docs/yarn-deploy-reset
docs: yarn deploy reset
2 parents 517b42b + 8237838 commit d597ca5

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

docs/quick-start/environment.mdx

+12
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,18 @@ yarn deploy --network {NETWORK_NAME} // when NETWORK_NAME is not specified, it d
3131

3232
This command deploys a sample smart contract to the local network. The contract is located in `packages/snfoundry/contracts/src` and can be modified to suit your needs. The `yarn deploy` command uses the deploy script located in `packages/snfoundry/scripts-js/deploy.js` to deploy the contract to the network. You can also customize the deploy script.
3333

34+
The command also will create a file called `packages/nextjs/contracts/deployedContracts.ts` within the Next.js App, which would be the ABI source-of-truth for the Scaffold Hooks. This enables autocomplete to be activated when you are building the Next.js front-end of the application.
35+
36+
:::tip
37+
38+
Note that `yarn deploy` does not reset the the generated `deployedContracts.ts` file, meaning that any changes that you made to the contract name or any deletion will not be taken into account, as it will only make the new deployment on top of the existing API. To completely start from a fresh state of deployment, you can run (do run with caution):
39+
40+
```
41+
yarn deploy:reset
42+
```
43+
44+
:::
45+
3446
### 3. Launch your NextJS Application
3547

3648
On a third terminal, start your NextJS app:

docs/quick-start/installation.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ curl --proto '=https' --tlsv1.2 -sSf https://docs.swmansion.com/scarb/install.sh
6565

6666
## Install `starknet-devnet`
6767

68-
To ensure the proper functioning of scaffold-stark, your local starknet-devnet version must be 0.0.4.
68+
To ensure the proper functioning of scaffold-stark, your local starknet-devnet version must be 0.0.4.
6969
To accomplish this, first check your local starknet-devnet version:
7070

7171
```
@@ -109,8 +109,8 @@ and set a global version:
109109
```bash
110110
asdf global starknet-foundry 0.27.0
111111
```
112-
</details>
113112

113+
</details>
114114

115115
## Install RPC
116116

@@ -138,7 +138,7 @@ curl --location 'https://starknet-sepolia.public.blastapi.io/rpc/v0_7' \
138138
To get started with Scaffold-Stark 2, you have two options:
139139

140140
1. Follow readme to clone the repository.
141-
2. **[Comming soon]** Use the npx command: ` npx create-stark@latest` to bootstrap the project directly.
141+
2. Use the npx command: ` npx create-stark@latest` to bootstrap the project directly.
142142

143143
### Option 1: Setup using `git clone`
144144

@@ -150,7 +150,7 @@ cd scaffold-stark-2
150150
yarn install
151151
```
152152

153-
### Option 2: [Comming soon] Setup using `npx create-stark@latest`
153+
### Option 2: Setup using `npx create-stark@latest`
154154

155155
For a simplified setup, Scaffold-Stark 2 offers a beta npx method that guides you interactively through the setup.
156156

0 commit comments

Comments
 (0)