Skip to main content
CodeGraph runs as a set of Docker containers.

​
Prerequisites

Docker

Docker Desktop or Docker Engine

Git

For cloning the repository

​
Installation

1

Clone the repository

git clone https://github.com/Lovos98/CodeGraph.git
cd CodeGraph
2

Configure environment

cp .env.example .env
Edit .env and set a strong password for GRAPH_DB_PASSWORD.
3

Start services

docker compose up -d
4

Open the app

Go to http://localhost:3000

​
Services

ServiceURLPort VariableDescription
webhttp://localhost:3000FRONTEND_PORTFrontend
apihttp://localhost:5050API_PORTAPI server
graphdbhttp://localhost:7474GRAPH_DB_HTTP_PORTGraph database browser
analyzer-ANALYZER_PORTCode analysis (internal)
layoutws://localhost:9002LAYOUT_PORTGPU layout engine (native)
The only required environment variable is GRAPH_DB_PASSWORD.

​
Encrypted Secrets

For teams, encrypt your .env with dotenvx: 
npx dotenvx encrypt
# Creates .env.keys - never commit this file

npx dotenvx run -- docker compose up -d

​
GPU Layout Engine (Optional)

For large graphs, the GPU layout engine provides faster computation. It runs natively (not in Docker) to access Metal GPU on macOS.
1

Install Rust

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
2

Build

cd gpu && cargo build --release
The API server auto-spawns the GPU server on demand.

​
Supported Backends

​
Graph Database

DatabaseStatus
Neo4j 5.xSupported
MemgraphPlanned

​
Layout Engine

BackendStatus
Metal (macOS)Supported
Vulkan (Linux/Windows)Untested
CPU fallbackPlanned
cuGraph (NVIDIA)Planned

​
What’s Next?

Quickstart

Analyze your first codebase