Skip to content

Commit

Permalink
Update the Dependencies installation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
vgao1996 committed Feb 10, 2025
1 parent 5f7c192 commit 427363c
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 11 deletions.
32 changes: 27 additions & 5 deletions workspace/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,37 @@ Aptos Workspace provides a testing environment framework for Aptos developers to

Aptos Workspace utilizes [mocha](https://mochajs.org/) as the testing framework and [chai](https://www.chaijs.com/) as the assertion framework.

## Prerequisites
Currently you'll need to have Docker installed on your system in order to use Aptos Workspace.
Docker is required because Aptos Workspace uses it to run a local indexer instance, which is part of the local network.

### Install Docker
## Dependencies
The following dependencies are needed for running Aptos Workspace. Make sure you
install them correctly.

### Node.js and npm
Install Node.js and npm by following the official guide:
- [Download and Install Node.js & npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)

### git
Git is required for the Move package system to fetch remote dependencies.
- **Mac**
- Install via homebrew: `brew install git`
- Install via MacPorts: `sudo port install git`
- **Windows**
- Download and install from: [Git for Windows](https://git-scm.com/downloads/win)
- **Linux**:
- Install via your package manager
- Detailed instructions here: [Git for Linux](https://git-scm.com/downloads/linux)

### Docker
Currently, Docker is required to run Aptos Workspace as it is used to run a local indexer instance, which is part of the local network used for simulation.

Follow these links to install Docker:
- **Mac**: Download [Docker Desktop for macOS](https://docs.docker.com/desktop/setup/install/mac-install/) from the Docker website.
- **Windows**: Download [Docker Desktop for Windows](https://docs.docker.com/desktop/setup/install/windows-install/) from the Docker website.
- **Linux**: Download [Docker Desktop for Linux](https://docs.docker.com/desktop/setup/install/linux/), or install [Docker Engine](https://docs.docker.com/engine/install/).

### Microsoft Visual C++ Redistributable (Windows Only)
Windows users must install the Microsoft Visual C++ Redistributable, in order to run the Aptos CLI executable, which is required for Aptos Workspace.
- Download and install from: [Microsoft VC++ Redistributable](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170)

## Getting Started

To start using Workspace you need to create an `npm project` by going to an empty folder (or `cd` into an existing one), and run:
Expand Down
12 changes: 6 additions & 6 deletions workspace/first-aptos-workspace-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

This is a tutorial that walks you through the steps to create a TS/JS project using Aptos Workspace. By the end, you’ll have a functional development setup with a sample Move contract and integration test.

# Step 0: Install Prerequisites
# Step 0: Install Dependencies

Before getting started, please make sure you have the necessary dependencies installed.

Follow the [Aptos Workspace README](https://github.com/aptos-labs/workspace/blob/main/workspace/README.md#prerequisites) to install prerequisites like **Docker**.

If you don’t have **Node.js** and **npm** installed, refer to the official installation guide:

- [https://docs.npmjs.com/downloading-and-installing-node-js-and-npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
Follow the [this section of the Aptos Workspace README](../README.md#Dependencies) to install the required Dependencies:
- Node.js and npm
- git
- Docker
- Microsoft VC++ Redistributable (windows only)

# Step 1: Initialize the npm Project

Expand Down

0 comments on commit 427363c

Please sign in to comment.