You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: workspace/README.md
+27-5Lines changed: 27 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -10,15 +10,37 @@ Aptos Workspace provides a testing environment framework for Aptos developers to
10
10
11
11
Aptos Workspace utilizes [mocha](https://mochajs.org/) as the testing framework and [chai](https://www.chaijs.com/) as the assertion framework.
12
12
13
-
## Prerequisites
14
-
Currently you'll need to have Docker installed on your system in order to use Aptos Workspace.
15
-
Docker is required because Aptos Workspace uses it to run a local indexer instance, which is part of the local network.
16
-
17
-
### Install Docker
13
+
## Dependencies
14
+
The following dependencies are needed for running Aptos Workspace. Make sure you
15
+
install them correctly.
16
+
17
+
### Node.js and npm
18
+
Install Node.js and npm by following the official guide:
19
+
-[Download and Install Node.js & npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
20
+
21
+
### git
22
+
Git is required for the Move package system to fetch remote dependencies.
23
+
-**Mac**
24
+
- Install via homebrew: `brew install git`
25
+
- Install via MacPorts: `sudo port install git`
26
+
-**Windows**
27
+
- Download and install from: [Git for Windows](https://git-scm.com/downloads/win)
28
+
-**Linux**:
29
+
- Install via your package manager
30
+
- Detailed instructions here: [Git for Linux](https://git-scm.com/downloads/linux)
31
+
32
+
### Docker
33
+
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.
34
+
35
+
Follow these links to install Docker:
18
36
-**Mac**: Download [Docker Desktop for macOS](https://docs.docker.com/desktop/setup/install/mac-install/) from the Docker website.
19
37
-**Windows**: Download [Docker Desktop for Windows](https://docs.docker.com/desktop/setup/install/windows-install/) from the Docker website.
20
38
-**Linux**: Download [Docker Desktop for Linux](https://docs.docker.com/desktop/setup/install/linux/), or install [Docker Engine](https://docs.docker.com/engine/install/).
21
39
40
+
### Microsoft Visual C++ Redistributable (Windows Only)
41
+
Windows users must install the Microsoft Visual C++ Redistributable, in order to run the Aptos CLI executable, which is required for Aptos Workspace.
42
+
- Download and install from: [Microsoft VC++ Redistributable](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170)
43
+
22
44
## Getting Started
23
45
24
46
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:
Copy file name to clipboardExpand all lines: workspace/first-aptos-workspace-project.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,15 @@
2
2
3
3
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.
4
4
5
-
# Step 0: Install Prerequisites
5
+
# Step 0: Install Dependencies
6
6
7
7
Before getting started, please make sure you have the necessary dependencies installed.
8
8
9
-
Follow the [Aptos Workspace README](https://github.com/aptos-labs/workspace/blob/main/workspace/README.md#prerequisites) to install prerequisites like **Docker**.
10
-
11
-
If you don’t have **Node.js** and **npm** installed, refer to the official installation guide:
0 commit comments