Building Locally

You can build the project locally from the GitHub repository if you want to make a change to the program, build for macOS, or if you just feel safer compiling it yourself.

Steps:

1. Clone the respoitory with a git client, or download the source code ZIP from GitHub and extract it.
2. Make sure you have NodeJS and npm (Node's package manager) installed.
3. In the project's root folder, run npm install to download the required dependencies.
4. Run npx electron-builder to compile the program. Any output should go in the dist folder.

The package.json file defines what types of files to output when building the application based on your platform in the "build" section. By default, it will build to: NSIS installer (exe) and portable zip for Windows; Debian installer (deb) and portable tar.xf for Linux; DMG file for macOS. Building on macOS has not been tested yet.

Learn more about the Electron Builder configuration here.

If you build the program locally, it will not show "Joshua Vickery" as the Verified Publisher.

Verifying Downloads

MD5 Sums:

Linux Distributions

The portable tar.xz file should work on most Linux distributions.

Codex has been tested on the following distros:

• Ubuntu 20.04
• Manjaro XFCE 21.0.3
• Arch Linux

Please create an issue on GitHub if Codex does not work on your distribution.