README.md

DB Grapher

A database schema designing tool that runs in browser. The application URL is https://dbgrapher.com.

To run

1. Run "npm i".
2. Run "npm run dev".

To test

1. Run "npm i" (if you didn't already)
2. Run "npm run test".

To test E2E

1. Run "npm i" (if you didn't already)
2. Run "npm run start-and-e2e-main".

Folder structure

The application is based on npm workspaces. The main application directory is under apps/main filder. The schema viewer web component is under libs/db-viewer.

The main application

The main application is written in lit and for state management, redux-toolkit has been used. For the build process vite has been used. For test vitest has been used. Currently, the test coverage is not great. For end to end tests, playwright has been used.

The DB viewer web component

The DB viewer web component displays the schema information. It uses svg to render the view. It is written in svelte. For the build process vite has been used. For the test vitest has been used.

TODO

1. Add import from SQL dump file.
2. Add schema formatting.
3. Add zoom to fit.
4. Improve test coverage.