Skip to content

Installation

Prerequisites

  • Node.js 20+
  • npm
  • Git

Clone and Install

# Clone the repository
git clone https://github.com/sorenwacker/graph-core.git
cd graph-core

# Install dependencies
npm install

Running the Application

Development Mode

# Web only (opens in browser)
npm run dev

# Electron app (recommended)
npm run electron:dev

Production Build

# Build for current platform
npm run electron:build

# Platform-specific builds
npm run electron:build:mac    # macOS
npm run electron:build:win    # Windows
npm run electron:build:linux  # Linux

Makefile Commands

Command Description
make dev Start Electron app in development mode
make install Install npm dependencies
make build Build Electron app for production
make stop Stop running dev servers
make clean Remove build artifacts
make reset-db Delete the SQLite database

Database Location

The SQLite database is stored in the Electron user data directory:

  • macOS: ~/Library/Application Support/graph-core/graph.db
  • Windows: %APPDATA%/graph-core/graph.db
  • Linux: ~/.config/graph-core/graph.db

Troubleshooting

Port Already in Use

If port 9743 is in use, Vite will automatically try the next available port.

Database Reset

To start fresh with a clean database:

make reset-db

Warning

This permanently deletes all data. There is a 3-second confirmation delay.

See Also