To run this project locally:
- Prerequisites: Make sure you've installed Node.js โฅ 12
- Install dependencies:
npm install
- Run the local development server:
npm run dev
(seepackage.json
for a full list ofscripts
you can run withnpm
)
Now you'll have a local development environment backed by the NEAR TestNet!
Go ahead and play with the app and the code. As you make code changes, the app will automatically reload.
- The smart-contract code lives in the
/contract
folder. See the README there for more info. In blockchain apps the smart contract is the "backend" of your app. - The frontend code lives in the
/frontend
folder./frontend/index.html
is a great place to start exploring. Note that it loads in/frontend/index.js
, this is your entrypoint to learn how the frontend connects to the NEAR blockchain. - Tests: there are different kinds of tests for the frontend and the smart
contract. See
contract/README
for info about how it's tested. The frontend code gets tested with jest. You can run both of these at once withnpm run test
.
Every smart contract in NEAR has its own associated account. When you run npm run dev
, your smart contract gets deployed to the live NEAR TestNet with a throwaway account. When you're ready to make it permanent, here's how.
near-cli is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local node_modules
folder when you ran npm install
, but for best ergonomics you may want to install it globally:
npm install --global near-cli
Or, if you'd rather use the locally-installed version, you can prefix all near
commands with npx
Ensure that it's installed with near --version
(or npx near --version
)
Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as your-name.testnet
, you can deploy your contract to near-blank-project.your-name.testnet
. Assuming you've already created an account on NEAR Wallet, here's how to create near-blank-project.your-name.testnet
:
-
Authorize NEAR CLI, following the commands it gives you:
near login
-
Create a subaccount (replace
YOUR-NAME
below with your actual account name):near create-account near-blank-project.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet
Modify the line in frontend/near-config.js
that sets the account name of the contract. Set it to the account id you used above.
const CONTRACT_NAME = process.env.CONTRACT_NAME || 'near-blank-project.YOUR-NAME.testnet'
This command will build and deploy the smart contract to NEAR Testnet:
npm run deploy
On Windows, if you're seeing an error containing EPERM
it may be related to spaces in your path. Please see this issue for more details.