From c882a79982bcf8efc72984a9a1a32990464afea4 Mon Sep 17 00:00:00 2001 From: mudassir-agoric Date: Mon, 13 May 2024 05:59:55 +0500 Subject: [PATCH] docs: Added text related to dependencies on node version and vite --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 958f24ed..a3bcce06 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,10 @@ This is a basic Agoric Dapp that contains three smart contracts `postal-service` ## Getting started -Assuming all the required dependecies are already installed (including node, nvm, docker, Keplr - See [here](https://docs.agoric.com/guides/getting-started/) tutorial on how to install these dependecies.), here are the steps to run `dapp-agoric-basics`: +Make sure all the required dependecies are already installed (including node, nvm, docker, Keplr, and that your node version is set to `18.x.x` by running `nvm use 18.20.2`. See [a tutorial here](https://docs.agoric.com/guides/getting-started/) on how to install these dependecies.). Here are the steps to run `dapp-agoric-basics`: - run `yarn install` in the `agoric-basics` directory, to install dependencies of the Dapp. - run `yarn start:docker` to start Agoric blockchain from the container. -- run `yarn docker:logs` to to make sure blocks are being produced by viewing the Docker logs; once your logs ressemeble the following, stop the logs by pressing `ctrl+c`. +- run `yarn docker:logs` to to make sure blocks are being produced by viewing the Docker logs; once your logs resemble the following, stop the logs by pressing `ctrl+c`. ``` demo-agd-1 | 2023-12-27T04:08:06.384Z block-manager: block 1003 begin demo-agd-1 | 2023-12-27T04:08:06.386Z block-manager: block 1003 commit @@ -17,7 +17,7 @@ demo-agd-1 | 2023-12-27T04:08:08.405Z block-manager: block 1005 begin demo-agd-1 | 2023-12-27T04:08:08.407Z block-manager: block 1005 commit ``` - run `yarn start:contract` to start the contracts. -- run `yarn start:ui` to start `sell-concert-tickets` contract UI. +- run `yarn start:ui` to start `sell-concert-tickets` contract UI. You will need `vite` for UI to start properly. You can install `vite` by running `yarn add vite`. - open a browser and navigate to `localhost:5173` to interact with the contract via UI. To follow more detailed tutorial, go [here](https://docs.agoric.com/guides/getting-started/tutorial-dapp-agoric-basics.html).