Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

md file #179

Open
wants to merge 7 commits into
base: tutorials
Choose a base branch
from
Open

md file #179

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a1e7755
md file
Oct 25, 2023
814cda7
downloading artifacts
Oct 25, 2023
bcae1fb
downloading artifacts
Oct 25, 2023
657b67e
using TS block instead of bash in md file
Oct 25, 2023
cfb615f
fixes
Oct 25, 2023
3bd3bab
referencing code
Oct 25, 2023
d9641af
fixes
Oct 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"@mdx-js/react": "^1.6.22",
"@nevermined-io/catalog": "^1.2.0",
"@nevermined-io/providers": "^1.2.0",
"@nevermined-io/sdk": "^1.2.0",
"@nevermined-io/sdk": "^2.0.0",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is the root package.json for the entire documentation. any reason why we are doing this?

"@nevermined-io/styles": "^0.1.1",
"axios": "^0.27.2",
"bem-helpers": "^1.1.0",
Expand Down
12 changes: 6 additions & 6 deletions tutorials/code/getting-started/yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -540,16 +540,16 @@
integrity sha512-N+0kuo9KgrUQ1Sn/ifDXsvg0TTleP7rIy4zOBGECxAljqvqfqpTfzx0Q1NUedOixRMBfe2Whhb056a42cWs26Q==

"@wry/context@^0.7.0", "@wry/context@^0.7.3":
version "0.7.3"
resolved "https://registry.yarnpkg.com/@wry/context/-/context-0.7.3.tgz#240f6dfd4db5ef54f81f6597f6714e58d4f476a1"
integrity sha512-Nl8WTesHp89RF803Se9X3IiHjdmLBrIvPMaJkl+rKVJAYyPsz1TEUbu89943HpvujtSJgDUx9W4vZw3K1Mr3sA==
version "0.7.4"
resolved "https://registry.yarnpkg.com/@wry/context/-/context-0.7.4.tgz#e32d750fa075955c4ab2cfb8c48095e1d42d5990"
integrity sha512-jmT7Sb4ZQWI5iyu3lobQxICu2nC/vbUhP0vIdd6tHC9PTfenmRmuIFqktc6GH9cgi+ZHnsLWPvfSvc4DrYmKiQ==
dependencies:
tslib "^2.3.0"

"@wry/equality@^0.5.6":
version "0.5.6"
resolved "https://registry.yarnpkg.com/@wry/equality/-/equality-0.5.6.tgz#cd4a533c72c3752993ab8cbf682d3d20e3cb601e"
integrity sha512-D46sfMTngaYlrH+OspKf8mIJETntFnf6Hsjb0V41jAXJ7Bx2kB8Rv8RCUujuVWYttFtHkUNp7g+FwxNQAr6mXA==
version "0.5.7"
resolved "https://registry.yarnpkg.com/@wry/equality/-/equality-0.5.7.tgz#72ec1a73760943d439d56b7b1e9985aec5d497bb"
integrity sha512-BRFORjsTuQv5gxcXsuDXx6oGRhuVsEGwZy6LOzRRfgu+eSfxbhUQ9L9YtSEIuIjY/o7g3iWFjrc5eSY1GXP2Dw==
dependencies:
tslib "^2.3.0"

Expand Down
13 changes: 7 additions & 6 deletions tutorials/tutorials/getting-started.md
View file
Open in desktop
fabriziogianni7 marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ This tutorial demonstrates a basic example of using the Nevermined SDK to intera
Ensure you have the following installed:

- Node.js
- npm (Node Package Manager)
- yarn (Node Package Manager)

## Setup

1. Install the Nevermined SDK package:

```bash
npm install @nevermined-io/sdk
```
yarn && yarn add @nevermined-io/sdk
Copy link
Member

@r-marques r-marques Oct 26, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yarn add should be enough


2. Create a TypeScript file (e.g., main.ts) and paste the following code:
```ts
Expand Down Expand Up @@ -45,15 +45,16 @@ Ensure you have the following installed:
main().then(() => process.exit(0))
```

3. Download the artifacts in the same folder:
3. From the root folder run:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe some explanation of what artifacts are and why they are needed would be nice

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I put " This will create an "artifacts" folder and download in it the Nevermined smart contract artifacts."
let me know what should I write there

```
wget -c https://artifacts.nevermined.network/421613/public/contracts_v3.5.2.tar.gz -O -| tar -xz --one-top-level=./artifacts
mkdir artifacts && cd artifacts && wget -c https://artifacts.nevermined.network/421613/public/contracts_v3.5.2.tar.gz && tar -xzvf contracts_v3.5.2.tar.gz
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this for the sake of simplicity?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it did not work in the other way

```
This will create an "artifacts" folder and download in it the Nevermined smart contract artifacts.

## Running the Code
Execute the following command to run the TypeScript file:

npm install @nevermined-io/sdk
yarn start
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this makes sense because we don't know how the user is using the code. This would only work on the getting-started code folder. I would just remove this part



This will initialize the Nevermined SDK, configure it with the specified options, and output information about SDK versions.
Expand Down
Loading