mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2026-04-29 15:37:48 +00:00
98 lines
2.6 KiB
Markdown
98 lines
2.6 KiB
Markdown
---
|
|
seo:
|
|
description: TODO
|
|
---
|
|
# Tutorial Template
|
|
|
|
This tutorial shows how to ***TODO: add summary and contextual information. See [Tutorial Guidelines](./tutorial-guidelines.md) for explanation. Parts that you should modify or remove are in bold-italic with the letters TODO.***
|
|
|
|
|
|
## Goals
|
|
|
|
By following this tutorial, you should learn how to:
|
|
|
|
- ***TODO: goals of the tutorial.***
|
|
- ***TODO: If the tutorial includes a graphical interface, include a screenshot of the final product here.***
|
|
|
|
## Prerequisites
|
|
|
|
To complete this tutorial, you should:
|
|
|
|
- Have a basic understanding of the XRP Ledger.
|
|
- Have an XRP Ledger client library, such as **xrpl.js**, installed.
|
|
- ***TODO: add and adjust prerequisites as required.***
|
|
|
|
|
|
## Source Code
|
|
|
|
You can find the complete source code for this tutorial's examples in the {% repo-link path="_code-samples/" %}code samples section of this website's repository{% /repo-link %}.
|
|
|
|
|
|
## Usage
|
|
|
|
***TODO: For single-file scripts that perform a linear set of steps without user input, omit the Usage section. For sample apps, provide some instructions on how to use the app.***
|
|
|
|
|
|
## Steps
|
|
|
|
### 1. Install dependencies
|
|
|
|
{% tabs %}
|
|
{% tab label="JavaScript" %}
|
|
From the code sample folder, use `npm` to install dependencies:
|
|
|
|
```sh
|
|
npm i
|
|
```
|
|
{% /tab %}
|
|
|
|
{% tab label="Python" %}
|
|
From the code sample folder, set up a virtual environment and use `pip` to install dependencies:
|
|
|
|
```sh
|
|
python -m venv .venv
|
|
source .venv/bin/activate
|
|
pip install -r requirements.txt
|
|
```
|
|
{% /tab %}
|
|
{% /tabs %}
|
|
|
|
### 2. Connect and get account(s)
|
|
|
|
To get started, import the client library and instantiate an API client. ***TODO: mention other details in this section, such as getting wallets/test accounts.***
|
|
|
|
{% tabs %}
|
|
{% tab label="JavaScript" %}
|
|
{% code-snippet file="/_code-samples/TODO/js/TODO.js" language="js" before="// TODO" /%}
|
|
{% /tab %}
|
|
|
|
{% tab label="Python" %}
|
|
{% code-snippet file="/_code-samples/TODO/py/TODO.py" language="py" before="# TODO" /%}
|
|
{% /tab %}
|
|
{% /tabs %}
|
|
|
|
|
|
### 3. ***TODO: more steps, as necessary***
|
|
|
|
***TODO: a brief description of what happens in this step***
|
|
|
|
{% tabs %}
|
|
{% tab label="JavaScript" %}
|
|
{% code-snippet file="/_code-samples/TODO/js/TODO.js" language="js" from="// TODO" before="// TODO next" /%}
|
|
{% /tab %}
|
|
|
|
{% tab label="Python" %}
|
|
{% code-snippet file="/_code-samples/TODO/py/TODO.py" language="py" from="# TODO" before="# TODO next" /%}
|
|
{% /tab %}
|
|
{% /tabs %}
|
|
|
|
***TODO: optional text following the code to describe expected outputs or details you should note for later.***
|
|
|
|
|
|
## See Also
|
|
|
|
***TODO: link related tutorials, references, and use cases.***
|
|
|
|
|
|
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|