Installation

JX Jarvis runs as an Electron desktop application with a React frontend and Python backend. This guide installs the project for local development and testing.

Prerequisites

• Windows 10 or Windows 11.
• Node.js 20 or newer.
• Python 3.11 or newer. The current development environment can also run on newer Python builds when dependencies support them.
• Git for cloning the repository.
• Chrome or Microsoft Edge for visible browser automation.
• A microphone if you plan to use voice activation.

Clone and install

git clone https://github.com/jojin1709/Jarvis-assistant.git
cd Jarvis-assistant
npm install
npm --prefix frontend install

Backend setup

The backend runs from the `backend` folder. It exposes the local API that powers voice, automation, browser control, memory, permissions, providers, and tools.

cd backend
python -m venv .venv
.\.venv\Scripts\python.exe -m pip install --upgrade pip
.\.venv\Scripts\python.exe -m pip install -r requirements.txt
.\.venv\Scripts\python.exe -m playwright install chromium
cd ..

Environment file

Copy the example file and add the keys you want to use. You can also add keys later through Settings -> AI Providers.

copy .env.example .env

Never commit `.env` or runtime files. The repository `.gitignore` excludes secrets and generated memory by default.

Install Desktop shortcut

Create a Windows Desktop shortcut that launches Jarvis with one double-click. On first launch, the shortcut launcher installs missing dependencies, prepares the Python backend, and opens the desktop app.

npm run install:desktop

The shortcut is named `Start JX JARVIS` and is added to the current user's Desktop.

Run in development

npm run dev

This starts the Vite frontend, launches Electron, and starts the Python backend. The splash screen appears first, then onboarding or the main UI.

Build and package