Skip to content

Commit

Permalink
applying suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
signorecello committed May 6, 2024
1 parent c902acd commit bc9dc5c
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 62 deletions.
66 changes: 5 additions & 61 deletions docs/docs/developers/getting_started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,7 @@
title: Quickstart
---

Getting started on Aztec is easy. Here are the three recommended ways of starting developing on Aztec:

- Codespaces - For a zero-requirement, <5min starter that runs on your grandma's IBM PC, you can use Github Codespaces, which is free up to 60h per month.
- `npx create-aztec-app` - Will guide you through the "Aztec Boxes": full boilerplate projects with a built-in sandbox. Requires node, docker and some 4gb RAM at least.
- Manual install - Install the sandbox and only the sandbox.

## 1. Codespaces

Please click one of these buttons and hit "create codespace":
The easiest way to start developing on Aztec is simply to click on one of these buttons:

[![One-Click React Starter](/img/codespaces_badges/react_cta_badge.svg)](https://codespaces.new/AztecProtocol/aztec-packages?devcontainer_path=.devcontainer%2Freact%2Fdevcontainer.json) [![One-Click HTML/TS Starter](/img/codespaces_badges/vanilla_cta_badge.svg)](https://codespaces.new/AztecProtocol/aztec-packages?devcontainer_path=.devcontainer%2Fvanilla%2Fdevcontainer.json) [![One-Click Token Starter](/img/codespaces_badges/token_cta_badge.svg)](https://codespaces.new/AztecProtocol/aztec-packages?devcontainer_path=.devcontainer%2Ftoken%2Fdevcontainer.json)

Expand All @@ -20,9 +12,11 @@ This creates a codespace with a prebuilt image containing one of the "Aztec Boxe
- You can develop directly on the codespace, push it to a repo, make yourself at home.
- You can also just use the sandbox that comes with it. The URL will be logged, you just need to use it as your `PXE_URL`.

## 2. Aztec Boxes
## Develop Locally

The above method uses Aztec boxes to install the sandbox and clone the repo. You can use it too to get started on your own machine and use your own IDE.

The above method uses Aztec boxes to install the sandbox and clone the repo. You can use it too to get started on your own machine and use your own IDE
You can also [install the sandbox manually](../sandbox/references/sandbox-reference.md).

### Prerequisites

Expand All @@ -41,56 +35,6 @@ And follow the instructions. If all goes well, you should now have a development

You can run `npx create-aztec-app sandbox -h` to start, stop, update and output logs from the sandbox.

## 3. Manual Install

If you don't want a boilerplate project, you can also install the sandbox via the underlying script used by the `npx` command.

### Prerequisites

- Node.js >= v18 (recommend installing with [nvm](https://github.com/nvm-sh/nvm))
- Docker (visit [this page of the Docker docs](https://docs.docker.com/get-docker/) on how to install it)

### Install the sandbox

To install the latest Sandbox version, run:

```bash
bash -i <(curl -s install.aztec.network)
```

This will install the following tools:

- **aztec** - launches various infrastructure subsystems (sequencer, prover, pxe, etc).
- **aztec-nargo** - aztec's build of nargo, the noir compiler toolchain.
- **aztec-sandbox** - a wrapper around docker-compose that launches services needed for sandbox testing.
- **aztec-up** - a tool to upgrade the aztec toolchain to the latest, or specific versions.
- **aztec-builder** - A useful tool for projects to generate ABIs and update their dependencies.

Once these have been installed, to start the sandbox, run:

```bash
aztec-sandbox
```

### Have fun!

**Congratulations, you have just installed and run the Aztec Sandbox!**

```bash
/\ | |
/ \ ___| |_ ___ ___
/ /\ \ |_ / __/ _ \/ __|
/ ____ \ / /| || __/ (__
/_/___ \_\/___|\__\___|\___|

```
In the terminal, you will see some logs:
1. Sandbox version
2. Contract addresses of rollup contracts
3. PXE (private execution environment) setup logs
4. Initial accounts that are shipped with the sandbox and can be used in tests
## What's next?

To deploy a smart contract to your sandbox and interact with it using Aztec.js, go to the [next page](aztecjs-getting-started.md).
Expand Down
53 changes: 52 additions & 1 deletion docs/docs/developers/sandbox/references/sandbox-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,61 @@ title: Sandbox Reference

:::tip

Follow the [quick start guide](../../getting_started/quickstart.md) to install the sandbox.
For a quick start, follow the [guide](../../getting_started/quickstart.md) to install the sandbox.

:::

## Manual Install

You can manually install the sandbox via the underlying script used in the [Aztec Boxes](../../getting_started/quickstart.md#run-the-npx-script).

### Prerequisites

- Node.js >= v18 (recommend installing with [nvm](https://github.com/nvm-sh/nvm))
- Docker (visit [this page of the Docker docs](https://docs.docker.com/get-docker/) on how to install it)

### Install the sandbox

To install the latest Sandbox version, run:

```bash
bash -i <(curl -s install.aztec.network)
```

This will install the following tools:

- **aztec** - launches various infrastructure subsystems (sequencer, prover, pxe, etc).
- **aztec-nargo** - aztec's build of nargo, the noir compiler toolchain.
- **aztec-sandbox** - a wrapper around docker-compose that launches services needed for sandbox testing.
- **aztec-up** - a tool to upgrade the aztec toolchain to the latest, or specific versions.
- **aztec-builder** - A useful tool for projects to generate ABIs and update their dependencies.

Once these have been installed, to start the sandbox, run:

```bash
aztec-sandbox
```

### Have fun!

**Congratulations, you have just installed and run the Aztec Sandbox!**

```bash
/\ | |
/ \ ___| |_ ___ ___
/ /\ \ |_ / __/ _ \/ __|
/ ____ \ / /| || __/ (__
/_/___ \_\/___|\__\___|\___|

```
In the terminal, you will see some logs:
1. Sandbox version
2. Contract addresses of rollup contracts
3. PXE (private execution environment) setup logs
4. Initial accounts that are shipped with the sandbox and can be used in tests
## Running Aztec PXE / Node / P2P-Bootstrap node
If you wish to run components of the Aztec network stack separately, you can use the `aztec start` command with various options for enabling components.
Expand Down

0 comments on commit bc9dc5c

Please sign in to comment.