CONTRIBUTE.md

Contributing

Requirements

This document will explain how to get started with Vortex development. First, make sure you have these general coding requirements:

• a GitHub account for creating pull requests,
• the git CLI or one GUI client like GitHub Desktop,
• an editor with TypeScript support like VSCode, WebStorm or Neovim.

Next, you need to install some build tools for Vortex:

• Volta for Node version management,
• and the .NET 9 SDK for building .NET projects.

Vortex depends on native Node modules which require node-gyp. You need to install a supported Python version and a C/C++ toolchain:

• Windows: VS 2022 Build Tools, follow node-gyp documentation for installation instructions
• Linux: make and GCC (package build-essentails on Debian/Ubuntu and base-devel on Arch Linux)

Starting with Python 3.12 you also need to install the setuptools packages. Verify your version by running python3 --version and install the package through pip or your system's package manager.

Setup

1. Clone the repository
2. volta install node@22
3. npm install --global corepack@latest
4. corepack install
5. pnpm run build:fomod
6. pnpm install

Developing

1. pnpm run build:all
2. pnpm run start

Packaging

1. pnpm run package:nosign

Further Reading

• Debugging
• Flatpak
• Docker Dev Containers
• Nix