https://github.com/aleksandr-kiliushin/db-visualizer

Visualize your DB particular records and their relations.
https://github.com/aleksandr-kiliushin/db-visualizer

databases postgresql visualization

Last synced: 2 months ago
JSON representation

Visualize your DB particular records and their relations.

• Host: GitHub
• URL: https://github.com/aleksandr-kiliushin/db-visualizer
• Owner: aleksandr-kiliushin
• Created: 2022-10-05T18:04:55.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-02-19T06:23:49.000Z (over 3 years ago)
• Last Synced: 2025-10-05T23:37:31.874Z (9 months ago)
• Topics: databases, postgresql, visualization
• Language: TypeScript
• Homepage:
• Size: 57.1 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

          
# DATABASE VISUALIZER · [![npm version](https://img.shields.io/npm/v/db-visualizer)](https://www.npmjs.com/package/db-visualizer)

A tool that helps visualize particular records and their relations.



## DEMO

https://user-images.githubusercontent.com/65129988/219932262-bd474aa5-d62e-412a-aeec-2fefd98d0e16.mp4

## FOR USERS

Visualization is available **only for PostgreSQL** for now.

1.  `npm install --save-dev db-visualizer`;

2.  `npm pkg set scripts.visualize-db="ts-node ./node_modules/db-visualizer/bin/index.js && npm --prefix ./node_modules/db-visualizer run dev:client"`;

3.  `mkdir ./.db-visualizer`;

4.  `touch ./.db-visualizer/config.js`.

5.  Specify your DB configuration. Example:

    ```

    module.exports = {

    	DB_HOST: "localhost",

    	DB_NAME: "my_app_db",

    	DB_PORT: "5432",

    	POSTGRES_PASSWORD: "123",

    	POSTGRES_USERNAME: "postgres",

    }

    ```

6.  Generate a dump of your DB and put it to `./.db-visualizer/dump.sql`;

7.  Add `/.db-visualizer/dump.sql` to `/.gitignore`;

8.  `npm run visualize-db`;

9.  Open http://localhost:3200/.

## FOR CONTRIBUTORS

1. `git clone git@github.com:aleksandr-kiliushin/db-visualizer.git`;

2. `cd db-visualizer`;

3. `npm i`;

4. `cp ./.env.example ./.env`;

5. `cp ./.db-visualizer/dump.sql.example ./.db-visualizer/dump.sql`;

6. `npm run launch-sample-db`;

7. `npm run restore-sample-db-from-dump`;

8. `npm run generate-db-portrait`;

9. `npm run test`.

10. `npm run dev:client`.