Skip to content

Commit

Permalink
Update docs with placeholders until release
Browse files Browse the repository at this point in the history
  • Loading branch information
Dr-Electron committed Jan 22, 2024
1 parent 7bdd135 commit c2ba134
Showing 1 changed file with 49 additions and 7 deletions.
56 changes: 49 additions & 7 deletions docs/build/iota-sandbox/docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Getting Started With the IOTA Sandbox

You can use this guide to [install](#install-the-iota-sandbox-using-docker)
Expand All @@ -9,24 +12,43 @@ It includes everything you need to develop your own IOTA dApps, plugins, and mor
### Requirements

1. A recent release of [Docker](https://www.docker.com/). Avoid using the Docker version shipped with your OS since these are mostly out of date. You can find installation instructions in the [official Docker documentation](https://docs.docker.com/).
2. [Docker Compose CLI plugin](https://docs.docker.com/compose/install/linux/).
3. Make sure ports 80, 80... are not in use by other applications. If they are change them in the `.env` file.

2. [Git](https://git-scm.com/).

### Clone the Repository
### Download the latest release

:::note

The commands assume you are using Linux.

:::

Once you have completed all the installation requirements,
you can clone the repo and navigate to the `sandbox` folder by running the following command:
Once you have completed all the installation [requirements](#requirements), you can download one of the latest releases, depending on the network you want to base the sandbox on, by running the following command:

<Tabs groupId="network" queryString>
<TabItem value="iota" label="IOTA">

```sh
mkdir iota-sandbox && cd iota-sandbox && curl -L https://github.com/Dr-Electron/iota-sandbox/releases/download/iota-v1.0.0-rc.1/iota-v1.0.0-rc.1_sandbox.tar.gz | tar -zx
```

</TabItem>
<TabItem value="shimmer" label="Shimmer">

```sh
mkdir iota-sandbox && cd iota-sandbox && curl -L https://github.com/Dr-Electron/iota-sandbox/releases/download/shimmer-v1.0.0-rc.1/shimmer-v1.0.0-rc.1_sandbox.tar.gz | tar -zx
```

</TabItem>
<TabItem value="testnet" label="Testnet">

```sh
git clone https://github.com/iotaledger/iota-sandbox && cd iota-sandbox/sandbox
mkdir iota-sandbox && cd iota-sandbox && curl -L https://github.com/Dr-Electron/iota-sandbox/releases/download/testnet-v1.0.0-rc.1/testnet-v1.0.0-rc.1_sandbox.tar.gz | tar -zx
```

</TabItem>
</Tabs>

### Prepare

:::note
Expand All @@ -38,10 +60,30 @@ The commands assume you are using Linux.
#### Set Up Your Environment

In most cases the default setup should be enough. But you can edit the `.env` file to configure some optional settings:
<Tabs groupId="network" queryString>
<TabItem value="iota" label="IOTA">

```sh reference
https://github.com/iotaledger/iota-sandbox/blob/main/iota/.env
```

</TabItem>
<TabItem value="shimmer" label="Shimmer">

```sh reference
https://github.com/iotaledger/iota-sandbox/blob/add-chronicle-setup/sandbox/.env
https://github.com/iotaledger/iota-sandbox/blob/shimmer/iota/.env
```

</TabItem>
<TabItem value="testnet" label="Testnet">

```sh reference
https://github.com/iotaledger/iota-sandbox/blob/main/testnet/.env
```

</TabItem>
</Tabs>

#### Bootstrap

If you haven't run the IOTA Sandbox before, you need to bootstrap it. To do that, just run the following command:
Expand Down

0 comments on commit c2ba134

Please sign in to comment.