manual, parsing devs

This commit is contained in:
Mik-TF 2024-05-14 11:13:17 -04:00
parent 6c76ffbfe5
commit 8ac3e56679

View File

@ -54,34 +54,16 @@ yarn add @threefold/grid_client
To use the Grid Client locally, clone the repository then install the Grid Client: To use the Grid Client locally, clone the repository then install the Grid Client:
- Clone the repository
```bash
git clone https://github.com/threefoldtech/tfgrid-sdk-ts
```
- Install the Grid Client
- With yarn
```bash
yarn install
```
- With npm
```bash
npm install
```
---
- Clone the repository - Clone the repository
```bash ```bash
git clone https://github.com/threefoldtech/tfgrid-sdk-ts git clone https://github.com/threefoldtech/tfgrid-sdk-ts
``` ```
- Install the Grid Client - Install the Grid Client with yarn or npm
- With yarn
```bash ```bash
yarn install yarn install
``` ```
- With npm
```bash ```bash
npm install npm install
``` ```
> Note: In the directory **grid_client/scripts**, we provided a set of scripts to test the Grid Client. > Note: In the directory **grid_client/scripts**, we provided a set of scripts to test the Grid Client.
@ -110,11 +92,11 @@ Make sure to set the client configuration properly before using the Grid Client.
The easiest way to test the installation is to run the following command with either yarn or npm to generate the Grid Client documentation: The easiest way to test the installation is to run the following command with either yarn or npm to generate the Grid Client documentation:
* With yarn * With yarn
* ``` ```
yarn run serve-docs yarn run serve-docs
``` ```
* With npm * With npm
* ``` ```
npm run serve-docs npm run serve-docs
``` ```
@ -127,11 +109,11 @@ You can explore the Grid Client by testing the different scripts proposed in **g
- Update your customized deployments specs if needed - Update your customized deployments specs if needed
- Run using [ts-node](https://www.npmjs.com/ts-node) - Run using [ts-node](https://www.npmjs.com/ts-node)
- With yarn - With yarn
- ```bash ```bash
yarn run ts-node --project tsconfig-node.json scripts/zdb.ts yarn run ts-node --project tsconfig-node.json scripts/zdb.ts
``` ```
- With npx - With npx
- ```bash ```bash
npx ts-node --project tsconfig-node.json scripts/zdb.ts npx ts-node --project tsconfig-node.json scripts/zdb.ts
``` ```