Skip to content

Commit 5064a0e

Browse files
docs: review to make clear the CLI should be use to manage the emulator
Signed-off-by: David Dal Busco <david.dalbusco@outlook.com>
1 parent 27154d9 commit 5064a0e

1 file changed

Lines changed: 23 additions & 4 deletions

File tree

docs/guides/local-development.mdx

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,26 @@
11
---
22
id: local-development
33
title: Local Development
4-
description: Set-up the local emulator with Docker or Podman
4+
description: Run a full local development environment with the Juno emulator using Docker or Podman, complete with Console UI, live reload, and smart contract support.
55
---
66

77
# Local Development
88

99
Juno offers something most platforms don’t: a full local development environment that closely mirrors production.
1010

11+
## TL;DR
12+
13+
| What | How |
14+
| ----------------- | ---------------------------------------------- |
15+
| Runtime supported | Docker or Podman |
16+
| Start emulator | `juno dev start` |
17+
| Stop emulator | `juno dev stop` |
18+
| Console UI URL | [http://localhost:5866](http://localhost:5866) |
19+
20+
---
21+
22+
## What the Emulator Includes
23+
1124
When you develop locally, you're running an emulator that includes the well known infrastructure services — including the actual administration Console UI.
1225

1326
This enables:
@@ -22,9 +35,9 @@ This enables:
2235

2336
## Before you begin
2437

25-
An emulator a self-contained local environment that includes services, replicas, and the Console UI — is run using containers. You can use [Docker](https://www.docker.com/) (default) or [Podman](https://podman.io/) as the container runtime.
38+
The emulator is a self-contained local environment that runs in a container managed entirely by Juno — using either [Docker](https://www.docker.com/) or [Podman](https://podman.io/) under the hood.
2639

27-
Make sure either tool is installed on your machine:
40+
Make sure your preferred runtime is installed on your machine:
2841

2942
- [Docker: Windows](https://docs.docker.com/desktop/install/windows-install/)
3043
- [Docker: macOS](https://docs.docker.com/desktop/install/mac-install/)
@@ -43,7 +56,7 @@ For **Podman**, we are not aware of any particular version requirements at this
4356

4457
## Getting Started
4558

46-
The easiest way to run the local developer environment is through the CLI.
59+
To run the emulator for local development, you need to have the Juno CLI installed.
4760

4861
If you haven’t installed it yet, run:
4962

@@ -67,6 +80,12 @@ To stop the emulator, run:
6780
juno dev stop
6881
```
6982

83+
:::note
84+
85+
While you could technically start the emulator using `docker run` or `podman run`, we recommend using the Juno CLI to manage the emulator lifecycle. It handles important checks, sets the correct configuration, and ensures everything runs as expected.
86+
87+
:::
88+
7089
---
7190

7291
## Available Images

0 commit comments

Comments
 (0)