logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt
How to install chartdb/chartdb. Official installation instructions. Project installation guide. Framework or library installation. Build installation instructions. How to setup and install from GitHub. Installation steps and setup instructions. Official docs and installation instructions GitHub.

chartdb/chartdb Installation Guide

How to install chartdb/chartdb. Official project installation instructions and setup guide.

⚡

Automated Install (Recommended)

Quick installation instructions for chartdb/chartdb. This is the fastest way to complete project installation and setup.

Install via curl

curl -fsSL https://hexmos.com/ipm-install | bash && 
ipm i chartdb/chartdb
or

Install via npx

npx @hexmos/ipm i chartdb/chartdb

Prerequisites

Node.js

language

Version: >=16.0.0

npm

package_manager

Version: 8.14.3

Python

language

PostgreSQL

system_package

MySQL

system_package

Version: 8.0.35

Docker

system_tool

Version: 20.10.1

Git

system_tool

Version: 2.38.1

Vite

build_tool

Version: 2.0.1

Fathom Analytics

service

Version: v1.0.0

Supabase

system_package

Version: 2.0.0

ClickHouse

system_package

Version: 1.4.0

CockroachDB

system_package

Version: 2.0.0

AWS Account Access

knowledge

GitHub

service

Version: v1.0.0

Manual Installation Methods

Manual installation instructions. How to install from GitHub source.

Local Development

git clone https://github.com/chartdb/chartdb.git

cd chartdb

npm install --non-interactive

npm run dev --non-interactive

Production Build

git clone https://github.com/chartdb/chartdb.git

cd chartdb

npm install --non-interactive

npm run build --non-interactive

Docker Deployment (Pre-built with AI)

docker run -e OPENAI_API_KEY=<YOUR_OPEN_AI_KEY> -p 8080:80 ghcr.io/chartdb/chartdb:latest

Docker Local Build and Run (with AI)

git clone https://github.com/chartdb/chartdb.git

cd chartdb

docker build -t chartdb .

docker run -e OPENAI_API_KEY=<YOUR_OPEN_AI_KEY> -p 8080:80 chartdb

Docker Deployment (Custom Inference Server)

git clone https://github.com/chartdb/chartdb.git

cd chartdb

docker build --build-arg VITE_OPENAI_API_ENDPOINT=<YOUR_ENDPOINT> --build-arg VITE_LLM_MODEL_NAME=<YOUR_MODEL_NAME> -t chartdb .

docker run -e OPENAI_API_ENDPOINT=<YOUR_ENDPOINT> -e LLM_MODEL_NAME=<YOUR_MODEL_NAME> -p 8080:80 chartdb

Docker Deployment (Pre-built without AI)

docker run -e DISABLE_ANALYTICS=true -p 8080:80 ghcr.io/chartdb/chartdb:latest

Docker Local Build and Run (without AI)

git clone https://github.com/chartdb/chartdb.git

cd chartdb

docker build --build-arg VITE_DISABLE_ANALYTICS=true -t chartdb .

docker run -e DISABLE_ANALYTICS=true -p 8080:80 chartdb

Post Installation Steps

  • Open your browser and navigate to http://localhost:8080 (for Docker) or the URL provided by the Vite dev server.
  • Select your database engine from the UI to obtain the 'Smart Query'.
  • Run the query in your database manager to export your schema as JSON.
  • Paste the resulting JSON into the ChartDB editor to visualize your schema.
← Back to toolAll Installation Guides