Home

Welcome to the Keystone developer setup guide. This page covers how to set up your local workspace environment, install core application files, and pull down the internal headless automation components required to generate diagnostics.

---

Prerequisites

Before starting, ensure you have the following core utilities installed on your system.

1. Node.js (v18 or later)

Keystone relies on Node.js for runtime execution and dependency management.

• macOS (via Homebrew): brew install node
• Windows (via winget): winget install OpenJS.NodeJS
• Linux (Debian/Ubuntu): sudo apt update && sudo apt install nodejs npm

2. Git

Required to clone the primary source repository.

• macOS: brew install git
• Windows: winget install Git.Git
• Linux: sudo apt install git

---

Workspace Setup

Run the following terminal commands in order to pull down the project files and configure your local workspace.

Step 1: Clone the Repository

git clone https://github.com/AKwasTaken/keystone.git
cd keystone

Step 2: Configure System Permissions

To allow the local environment to pull down structural assets from third-party repositories without hitting strict protocol blockages, set the npm Git allocation parameter globally before continuing:

npm config set allow-git all

Step 3: Install Package Dependencies

Installs core UI frameworks and Electron Forge workspace environments:

npm install

Launching Development Mode (optional)

Once your configuration setup is complete, boot up the interface workbench locally using the application script layer:

npm start

The main canvas cockpit layout will launch directly on your desktop.

Step 5: Building the app

Once the modules installation is complete, you can build your own portable binary. Run:

npm run build

More on it on this page.

---