Skip to content

Commit 446af46

Browse files
swidnikkgitbook-bot
swidnikk
authored and
gitbook-bot
committed
GITBOOK-372: change request with no subject merged in GitBook
1 parent 9d8b035 commit 446af46

3 files changed

Lines changed: 132 additions & 132 deletions

File tree

‎docs/README (1).md‎

Lines changed: 61 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,89 @@
1-
# Getting Started
1+
---
2+
description: >-
3+
This page describes first steps with the Guardian and digital environmental
4+
assets for all users.
5+
---
26

3-
## **1. Introduction**
7+
# First steps with digital environmental assets (simplified)
48

5-
The Guardian is an open-source platform that streamlines the creation, management, and verification of digital environmental assets. It leverages a customizable Policy Workflow Engine and Web3 technology to ensure transparent and fraud-proof operations, making it a key tool for transforming sustainability practices & carbon markets.
9+
{% hint style="warning" %}
10+
This page is under development and part of the **3.7 Getting Started Epic** 
611

7-
Below are the universal software prerequisites, followed by network-specific items.
12+
The purpose of this page is to create a friendly guide to help a new user take their first steps in the Hedera Guardian. This page is descriptive only and will introduce all users of high level concepts without relying upon custom setuup, roles, permissions, or test data.
13+
{% endhint %}
814

9-
## 2. Prerequisites
15+
* #### Get set up • 0/5 steps
1016

11-
### 2.1 Universal software
17+
{% stepper %}
18+
{% step %}
19+
### Set up your Hedera account
1220

13-
1. [Git](https://git-scm.com/downloads) – source-control tooling
14-
2. [Docker](https://www.docker.com/) – one-command build & run
15-
3. [MongoDB v6](https://www.mongodb.com/), [Node.js v16](https://nodejs.org/en), and [NATS 1.12.2](https://nats.io/) – auto-installed when using Docker-Compose
16-
4. [Web3.Storage account](https://web3.storage/) – IPFS pinning service
17-
5. [Filebase account](https://filebase.com/) – S3-compatible IPFS pinning
18-
6. [Redis 7.3.0](https://redict.io/) – in-memory cache & message broker (auto-provisioned by the Docker stack)
21+
<details>
1922

20-
### 2.2 Hedera network
23+
<summary>Details on setting up a Hedera account</summary>
2124

22-
| | Testnet (default) | Mainnet (production) |
23-
| ------------ | --------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
24-
| **Account** | Create via [Hedera Developer Portal](https://portal.hedera.com/login) | Create via Hedera-enabled wallet (e.g., [HashPack](https://www.hashpack.app/)) |
25-
| **Key type** | ED25519 | ED25519 |
26-
| **Network** | `testnet` | `mainnet` |
25+
1. Create a Testnet account via the [Hedera Developer Portal](https://portal.hedera.com/login).
26+
2. Record your **Account ID** (`0.0.x`).
27+
3. Download the **ED25519** private key (ignore **ECDSA**)
28+
* Select **DER Encoded** — _do not_ choose _HEX Encoded_.
2729

28-
> **Fees**: Mainnet operations incur HBAR costs—fund your account before running Guardian.
30+
</details>
31+
{% endstep %}
2932

30-
***
33+
{% step %}
34+
### Import a policy
3135

32-
## 3. Preparing a Mainnet Account & Keys
36+
<details>
3337

34-
1. Install a Hedera-enabled wallet (e.g., [HashPack](https://www.hashpack.app/)).
35-
2. Create a Mainnet account and note the **Account ID** (`0.0.x`).
36-
3. Export the **ED25519** key pair
37-
* _HashPack path_: **Settings → Manage Accounts → Export Private Key** (DER format).
38-
4. Update your `.env`
38+
<summary>Import a policy from the methodology library</summary>
3939

40-
```dotenv
41-
HEDERA_NET=mainnet
42-
HEDERA_OPERATOR_ID=0.0.123456
43-
HEDERA_OPERATOR_KEY=-----BEGIN PRIVATE KEY----- … -----END PRIVATE KEY-----
44-
```
40+
Policy's are digital workflows and are at the heart of the Guardian. Visit \[LINK: AUTHOR] to import a sample policy from the methodology library.
4541

46-
## 4. Preparing a Testnet Account & Keys
42+
</details>
43+
{% endstep %}
44+
45+
{% step %}
46+
### Publish a policy to testnet
47+
48+
<details>
49+
50+
<summary>Publish your first policy to the Hedera testnet </summary>
51+
52+
Visit the \[LINK: REGISTRY] to publish your first policy. This is how registry operators would publish policies and begin accepting submissions.&#x20;
53+
54+
</details>
4755

48-
1. Create a Testnet account via the [Hedera Developer Portal](https://portal.hedera.com/login).
49-
2. Record your **Account ID** (`0.0.x`).
50-
3. Download the **ED25519** private key (ignore **ECDSA**)
51-
* Select **DER Encoded** — _do not_ choose _HEX Encoded_.
52-
4. Update your `.env`
5356

54-
```dotenv
55-
HEDERA_NET=testnet
56-
HEDERA_OPERATOR_ID=0.0.987654
57-
HEDERA_OPERATOR_KEY=-----BEGIN PRIVATE KEY----- … -----END PRIVATE KEY-----
58-
```
57+
{% endstep %}
5958

60-
## 5. Installation
59+
{% step %}
60+
### Submit data
6161

62-
1. **Docker-Compose**
62+
<details>
6363

64-
```bash
65-
docker compose -f ./deploy/docker-compose.yml --profile all up -d
66-
```
64+
<summary>Project proponents submit data </summary>
6765

68-
_(Detects Testnet/Mainnet from `.env`)_
69-
2. **Pre-built containers** — pull `hashgraph/guardian:latest` and supply `.env` as a secret.
70-
3. **Manual build** — clone repo, install Node deps, compile, start services.
66+
Visit a \[LINK: PROJECT] to view your policy running on testnet and submit data. This is how a project proponents would submit their project for verification and validation.&#x20;
7167

72-
## **6. Troubleshooting**
68+
</details>
69+
{% endstep %}
7370

74-
* **Server not starting?** Ensure that Docker is running and all containers are up.
75-
* **Cannot access the admin dashboard?** Check if the correct ports (3000) are open and not blocked by your firewall.
76-
* **Issues with API calls?** Verify that your Hedera account ID and private key are correctly configured in the `.env` file.
77-
* For additional help, visit the [Hedera Guardian GitHub Issues](https://github.com/hashgraph/guardian/issues).
71+
{% step %}
72+
### Inspect documents
7873

79-
## **7. Additional Resources**
74+
<details>
8075

81-
* [Hedera Guardian Documentation](https://guardian.hedera.com)
82-
* [Hedera Developer Portal](https://portal.hedera.com/login)
83-
* [Roadmap](guardian/readme/roadmap.md)
84-
* [Youtube Channel](https://www.youtube.com/@envisionblockchain/featured)
76+
<summary>Visit the Audit section to inspect documents</summary>
8577

86-
## **8. Feedback and Support**
78+
Visit the \[LINK: AUDIT] interface to inspect the documents created after data was submitted for the policy. This is how auditors and VVBs would review projects submitted by project proponents.&#x20;
8779

88-
* Please send feedback, feature, and support requests to [guardian-feedback@hashgraph.com](mailto:guardian-feedback@hashgraph.com?subject=Re:%20Hedera%20Guardian%20Feedback%20or%20Request\&body=This%20is%20%5Bfeedback%20%7C%20support%20request%20%7C%20feature%20request%5D%0A%0A--%0A%0AAdd%20a%20summary%20here.)&#x20;
89-
* You can also open issues and feature requests in the [GitHub repository](https://github.com/hashgraph/guardian/issues).
80+
</details>
81+
{% endstep %}
82+
{% endstepper %}
9083

91-
## **9. Legal and Licensing**
84+
### Go further
9285

93-
* Hedera Guardian is open-source and licensed under the Apache 2.0 License. Please review the [LICENSE](../LICENSE/) file for more details.
86+
* LINK Digitizing Methodology Guide
87+
* LINK Subscribe to community calendar
88+
* LINK Feedback & Support
89+
* LINK Contributing

‎docs/README.md‎

Lines changed: 65 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,89 +1,93 @@
1-
---
2-
description: >-
3-
This page describes first steps with the Guardian and digital environmental
4-
assets for all users.
5-
---
1+
# Getting Started
62

7-
# First steps with digital environmental assets (simplified)
3+
## **1. Introduction**
84

9-
{% hint style="warning" %}
10-
This page is under development and part of the **3.7 Getting Started Epic**&#x20;
5+
The Guardian is an open-source platform that streamlines the creation, management, and verification of digital environmental assets. It leverages a customizable Policy Workflow Engine and Web3 technology to ensure transparent and fraud-proof operations, making it a key tool for transforming sustainability practices & carbon markets.
116

12-
The purpose of this page is to create a friendly guide to help a new user take their first steps in the Hedera Guardian. This page is descriptive only and will introduce all users of high level concepts without relying upon custom setuup, roles, permissions, or test data.
13-
{% endhint %}
7+
Below are the universal software prerequisites, followed by network-specific items.
148

15-
* #### Get set up • 0/5 steps
9+
## 2. Prerequisites
1610

17-
{% stepper %}
18-
{% step %}
19-
### Set up your Hedera account
11+
### 2.1 Universal software
2012

21-
<details>
13+
1. [Git](https://git-scm.com/downloads) – source-control tooling
14+
2. [Docker](https://www.docker.com/) – one-command build & run
15+
3. [MongoDB v6](https://www.mongodb.com/), [Node.js v16](https://nodejs.org/en), and [NATS 1.12.2](https://nats.io/) – auto-installed when using Docker-Compose
16+
4. [Web3.Storage account](https://web3.storage/) – IPFS pinning service
17+
5. [Filebase account](https://filebase.com/) – S3-compatible IPFS pinning
18+
6. [Redis 7.3.0](https://redict.io/) – in-memory cache & message broker (auto-provisioned by the Docker stack)
2219

23-
<summary>Details on setting up a Hedera account</summary>
20+
### 2.2 Hedera network
2421

25-
1. Create a Testnet account via the [Hedera Developer Portal](https://portal.hedera.com/login).
26-
2. Record your **Account ID** (`0.0.x`).
27-
3. Download the **ED25519** private key (ignore **ECDSA**)
28-
* Select **DER Encoded** — _do not_ choose _HEX Encoded_.
29-
30-
</details>
31-
{% endstep %}
32-
33-
{% step %}
34-
### Import a policy
35-
36-
<details>
22+
| | Testnet (default) | Mainnet (production) |
23+
| ------------ | --------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
24+
| **Account** | Create via [Hedera Developer Portal](https://portal.hedera.com/login) | Create via Hedera-enabled wallet (e.g., [HashPack](https://www.hashpack.app/)) |
25+
| **Key type** | ED25519 | ED25519 |
26+
| **Network** | `testnet` | `mainnet` |
3727

38-
<summary>Import a policy from the methodology library</summary>
28+
> **Fees**: Mainnet operations incur HBAR costs—fund your account before running Guardian.
3929
40-
Policy's are digital workflows and are at the heart of the Guardian. Visit \[LINK: AUTHOR] to import a sample policy from the methodology library.
30+
***
4131

42-
</details>
43-
{% endstep %}
32+
## 3. Preparing a Mainnet Account & Keys
4433

45-
{% step %}
46-
### Publish a policy to testnet
34+
1. Install a Hedera-enabled wallet (e.g., [HashPack](https://www.hashpack.app/)).
35+
2. Create a Mainnet account and note the **Account ID** (`0.0.x`).
36+
3. Export the **ED25519** key pair
37+
* _HashPack path_: **Settings → Manage Accounts → Export Private Key** (DER format).
38+
4. Update your `.env`
4739

48-
<details>
40+
```dotenv
41+
HEDERA_NET=mainnet
42+
HEDERA_OPERATOR_ID=0.0.123456
43+
HEDERA_OPERATOR_KEY=-----BEGIN PRIVATE KEY----- … -----END PRIVATE KEY-----
44+
```
4945
50-
<summary>Publish your first policy to the Hedera testnet </summary>
51-
52-
Visit the \[LINK: REGISTRY] to publish your first policy. This is how registry operators would publish policies and begin accepting submissions.&#x20;
53-
54-
</details>
46+
## 4. Preparing a Testnet Account & Keys
5547
48+
1. Create a Testnet account via the [Hedera Developer Portal](https://portal.hedera.com/login).
49+
2. Record your **Account ID** (`0.0.x`).
50+
3. Download the **ED25519** private key (ignore **ECDSA**)
51+
* Select **DER Encoded** — _do not_ choose _HEX Encoded_.
52+
4. Update your `.env`
5653
57-
{% endstep %}
54+
```dotenv
55+
HEDERA_NET=testnet
56+
HEDERA_OPERATOR_ID=0.0.987654
57+
HEDERA_OPERATOR_KEY=-----BEGIN PRIVATE KEY----- … -----END PRIVATE KEY-----
58+
```
5859
59-
{% step %}
60-
### Submit data
60+
## 5. Installation
6161
62-
<details>
62+
1. **Docker-Compose**
6363
64-
<summary>Project proponents submit data </summary>
64+
```bash
65+
docker compose -f ./deploy/docker-compose.yml --profile all up -d
66+
```
6567
66-
Visit a \[LINK: PROJECT] to view your policy running on testnet and submit data. This is how a project proponents would submit their project for verification and validation.&#x20;
68+
_(Detects Testnet/Mainnet from `.env`)_
69+
2. **Pre-built containers** — pull `hashgraph/guardian:latest` and supply `.env` as a secret.
70+
3. **Manual build** — clone repo, install Node deps, compile, start services.
6771
68-
</details>
69-
{% endstep %}
72+
## **6. Troubleshooting**
7073
71-
{% step %}
72-
### Inspect documents
74+
* **Server not starting?** Ensure that Docker is running and all containers are up.
75+
* **Cannot access the admin dashboard?** Check if the correct ports (3000) are open and not blocked by your firewall.
76+
* **Issues with API calls?** Verify that your Hedera account ID and private key are correctly configured in the `.env` file.
77+
* For additional help, visit the [Hedera Guardian GitHub Issues](https://github.com/hashgraph/guardian/issues).
7378
74-
<details>
79+
## **7. Additional Resources**
7580
76-
<summary>Visit the Audit section to inspect documents</summary>
81+
* [Hedera Guardian Documentation](https://guardian.hedera.com)
82+
* [Hedera Developer Portal](https://portal.hedera.com/login)
83+
* [Roadmap](guardian/readme/roadmap.md)
84+
* [Youtube Channel](https://www.youtube.com/@envisionblockchain/featured)
7785
78-
Visit the \[LINK: AUDIT] interface to inspect the documents created after data was submitted for the policy. This is how auditors and VVBs would review projects submitted by project proponents.&#x20;
86+
## **8. Feedback and Support**
7987
80-
</details>
81-
{% endstep %}
82-
{% endstepper %}
88+
* Please send feedback, feature, and support requests to [guardian-feedback@hashgraph.com](mailto:guardian-feedback@hashgraph.com?subject=Re:%20Hedera%20Guardian%20Feedback%20or%20Request\&body=This%20is%20%5Bfeedback%20%7C%20support%20request%20%7C%20feature%20request%5D%0A%0A--%0A%0AAdd%20a%20summary%20here.)&#x20;
89+
* You can also open issues and feature requests in the [GitHub repository](https://github.com/hashgraph/guardian/issues).
8390
84-
### Go further
91+
## **9. Legal and Licensing**
8592
86-
* LINK Digitizing Methodology Guide
87-
* LINK Subscribe to community calendar
88-
* LINK Feedback & Support
89-
* LINK Contributing
93+
* Hedera Guardian is open-source and licensed under the Apache 2.0 License. Please review the [LICENSE](../LICENSE/) file for more details.

‎docs/SUMMARY.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,8 @@
11
# Table of contents
22

3-
## First Steps
4-
5-
* [First steps with digital environmental assets (simplified)](README.md)
6-
* [First steps with digital environmental assets (complex)](first-steps/first-steps-with-digital-environmental-assets-complex.md)
7-
83
## Guardian
94

10-
* [Getting Started](<README (1).md>)
5+
* [Getting Started](README.md)
116
* [Discovering Environmental assets on Hedera](guardian/readme/discovering-esg-assets-on-hedera.md)
127
* [Guardian Glossary](guardian/readme/guardian-glossary.md)
138
* [Installation Guide](guardian/readme/getting-started/README.md)
@@ -1102,6 +1097,11 @@
11021097
* [⚙️ Guardian Integration](methodology-digitization-handbook/_shared/guardian-integration/README.md)
11031098
* [🗂️ Artifacts Collection](methodology-digitization-handbook/_shared/artifacts/README.md)
11041099

1100+
## First Steps
1101+
1102+
* [First steps with digital environmental assets (simplified)](<README (1).md>)
1103+
* [First steps with digital environmental assets (complex)](first-steps/first-steps-with-digital-environmental-assets-complex.md)
1104+
11051105
## AI-ToolKit
11061106

11071107
* [Hedera Guardian AI Toolkit](ai-toolkit/hedera-guardian-ai-toolkit.md)

0 commit comments

Comments
 (0)
⚡