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.

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

md file #179

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

md file #179

wants to merge 7 commits into from

Conversation

fabriziogianni7
Copy link

Description

Adding Md file to getting started tutorial

Is this PR related with an open issue?

Related to Issue #170
closes #170

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • Follows the code style of this project.
  • Tests Cover Changes
  • Documentation

@fabriziogianni7 fabriziogianni7 requested review from a team as code owners October 25, 2023 08:43
Base automatically changed from feat/boilerplate to tutorials October 25, 2023 08:48
```bash
npm install @nevermined-io/sdk
```
yarn && yarn add @nevermined-io/sdk
Copy link
Member

@r-marques r-marques Oct 26, 2023

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

```
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

Comment on lines 54 to 57
## 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

@@ -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

"@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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants