On this page

Setting up development environment

Prerequisites

Node.js ^19.1.0
npm ^8.19.0
Visual Studio Build Tools 2019 community edition
Android Studio ^2022.1.1 (if planning on developing for android)

Cloning for the first time

When cloning for the first time it's important to use the --recurse-submodules flag as Amethyst has submodules that are required for it to work.

sh

$ git clone --recurse-submodules https://github.com/geoxor/amethyst && cd amethyst

Install Yarn if you don't have it already

sh

$ npm i -g yarn

Install dependencies

sh

$ yarn

Once complete the repository should be ready to work on

Recommendations

It is recommended to use Visual Studio Code for development as the repository has extension configs to aid with development