​
Cloning & setting up

Prerequisite: Please install Node.js (version 20 or higher) and yarn before proceeding.

Follow these steps to clone and run Amethyst on your development platform:

Step 1: Clone the repository:

git clone https://github.com/Geoxor/Amethyst

Step 2: Navigate to the Amethyst directory and execute the following command:

yarn

Step 3: Execute this command to start the development server:

yarn dev

Amethyst should launch when ready with live-refresh capability

​
Compiling

The following command will build Amethyst for your platform:

yarn package

Build files will be populated in the release/build