​
Prerequisites

​
Shared

  • Git
  • Node.js v20.17.0 (LTS)
    • nvm is encouraged for node version management
  • Yarn

Make sure you’re using node.js v20.17.0 as any other version is unsupported and may cause unforeseen issues or unintended behaviour

​
Git

​
Node installation (nvm)

If you use nvm you can install Node.js v20.17.0 with the following commands:

nvm install 20.17.0

nvm use 20.17.0

​
Yarn Installation

After installing Node.js v20.17.0 please install yarn through npm:

npm -g i yarn

The following command installs yarn as an global package in npm

​
Linux

  • C/C++ development tools
    • Fedora/RHEL: dnf group install c-development
    • Arch: pacman -S gcc g++
    • Debian: apt install gcc g++
  • libvips
    • Fedora/RHEL: dnf install vips-devel
    • Arch: pacman -S libvips
    • Debian: apt install libvips-dev

​
Setup

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

​
Cloning the repository

If you have set up ssh for Github you can optionally clone the repository with ssh, if you do not know what that means, follow the HTTPS section.

​
HTTPS

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

​
SSH

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

​
Installing dependencies

The following command will install the required node dependencies:

yarn

​
Development

​
Amethyst

The following command will launch the development version of Amethyst:

yarn dev

​
Documentation

The documentation is stored in docs/ folder.

The following command will start local development server:

yarn docs

​
Linting

The following command will run the linter:

yarn lint

The following command will attempt to fix linter issues automatically:

yarn lint:fix

​
Packaging

​
Executable

The following command will package Amethyst for your platform:

yarn package

Build files can be found from the release/build folder