database-studio 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +104 -0
- package/dist/README.md +104 -0
- package/dist/public.pem +9 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
# Database Studio App 🚀
|
|
2
|
+
|
|
3
|
+
[](./package.json)
|
|
4
|
+
[](#license)
|
|
5
|
+
[](#tech-stack)
|
|
6
|
+
|
|
7
|
+
**Database Studio App** is a high-performance, full-stack database management and visualization tool. Designed for developers and database administrators, it provides a modern, intuitive interface to explore, analyze, and document your MySQL databases with ease.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## 🌟 Key Features
|
|
12
|
+
|
|
13
|
+
### 📊 Interactive Database Viewer
|
|
14
|
+
Explore your data with a high-speed, paginated data table. View real-time records from your MySQL tables with a clean, responsive interface.
|
|
15
|
+
|
|
16
|
+
### 📐 Visual Schema Explorer
|
|
17
|
+
Visualize your entire database architecture at a glance. Our grid-based **Schema View** transforms complex table relationships into beautiful, interactive cards with dynamic color-coding.
|
|
18
|
+
|
|
19
|
+
### 📄 Professional PDF Documentation
|
|
20
|
+
Generate high-fidelity database schema reports with a single click. Powered by **Puppeteer** server-side rendering, our exports ensure 100% style accuracy and a professional A4 print layout.
|
|
21
|
+
|
|
22
|
+
### 🔐 Enterprise-Grade Security
|
|
23
|
+
- **Machine-ID Binding**: Licenses are securely tied to unique hardware identifiers.
|
|
24
|
+
- **JWT Authentication**: Secure session management using JSON Web Tokens and HTTP-only cookies.
|
|
25
|
+
- **RSA-256 Verification**: Offline license verification using public/private key pairs.
|
|
26
|
+
|
|
27
|
+
### 🛠️ Developer-First Experience
|
|
28
|
+
- **Customizable Layout**: Toggle between 1-4 column grid views.
|
|
29
|
+
- **View Switching**: Seamlessly jump between raw data and architectural schemas.
|
|
30
|
+
- **Fast Search**: Quickly find the tables and columns you need.
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## 🚀 Quick Start
|
|
35
|
+
|
|
36
|
+
### Prerequisites
|
|
37
|
+
- **Node.js**: v18 or higher
|
|
38
|
+
- **pnpm**: Recommended package manager
|
|
39
|
+
- **MySQL**: Access to a running MySQL instance
|
|
40
|
+
|
|
41
|
+
### Installation
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
# Install dependencies
|
|
45
|
+
pnpm install
|
|
46
|
+
|
|
47
|
+
# Build the application
|
|
48
|
+
pnpm build
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Environment Configuration
|
|
52
|
+
|
|
53
|
+
Create a `.env` file in the root of the `studio-app` directory:
|
|
54
|
+
|
|
55
|
+
```env
|
|
56
|
+
MYSQL_URL=mysql://user:password@localhost:3306/your_database
|
|
57
|
+
LICENSE_SERVER_URL=http://your-license-server.com
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
|
|
62
|
+
## 💻 Tech Stack
|
|
63
|
+
|
|
64
|
+
- **Frontend**: [React 18](https://react.dev/), [React Router 6](https://reactrouter.com/), [Tailwind CSS 3](https://tailwindcss.com/)
|
|
65
|
+
- **Backend**: [Express 5](https://expressjs.com/), [Puppeteer](https://pptr.dev/)
|
|
66
|
+
- **UI Components**: [Radix UI](https://www.radix-ui.com/), [Lucide Icons](https://lucide.dev/)
|
|
67
|
+
- **Database**: [MySQL](https://www.mysql.com/)
|
|
68
|
+
- **Build System**: [Vite](https://vitejs.dev/), [tsup](https://tsup.egoist.dev/)
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## 🏗️ Project Architecture
|
|
73
|
+
|
|
74
|
+
```text
|
|
75
|
+
client/ # Modern React SPA
|
|
76
|
+
├── components/ # Reusable UI & Logic components
|
|
77
|
+
├── pages/ # Route-level components
|
|
78
|
+
└── lib/ # Utilities and API wrappers
|
|
79
|
+
|
|
80
|
+
server/ # Express API & Documentation Engine
|
|
81
|
+
├── index.ts # Main entry point with License & PDF logic
|
|
82
|
+
└── config.ts # Server configuration
|
|
83
|
+
|
|
84
|
+
bin/ # CLI tools for global linking
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## 📑 PDF Export Engine
|
|
90
|
+
|
|
91
|
+
Our export engine doesn't just "print" the page. It uses a sophisticated server-side flow:
|
|
92
|
+
1. **Headless Navigation**: Puppeteer visits a specialized `?export=true` route.
|
|
93
|
+
2. **Adaptive CSS**: The app re-renders specifically for print, enforcing a single-column layout and hiding interactive elements.
|
|
94
|
+
3. **True Fidelity**: Captures full Tailwind colors and styles into a multi-page A4 PDF.
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## 🔒 License & Security
|
|
99
|
+
|
|
100
|
+
This application requires a valid license key for operation. The licensing system uses **RSA-256** signatures to ensure integrity and **Machine-ID** hashing to prevent unauthorized distribution.
|
|
101
|
+
|
|
102
|
+
---
|
|
103
|
+
|
|
104
|
+
*Part of the [Database Studio Workspace](../../README.md).*
|
package/dist/README.md
ADDED
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
# Database Studio App 🚀
|
|
2
|
+
|
|
3
|
+
[](./package.json)
|
|
4
|
+
[](#license)
|
|
5
|
+
[](#tech-stack)
|
|
6
|
+
|
|
7
|
+
**Database Studio App** is a high-performance, full-stack database management and visualization tool. Designed for developers and database administrators, it provides a modern, intuitive interface to explore, analyze, and document your MySQL databases with ease.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## 🌟 Key Features
|
|
12
|
+
|
|
13
|
+
### 📊 Interactive Database Viewer
|
|
14
|
+
Explore your data with a high-speed, paginated data table. View real-time records from your MySQL tables with a clean, responsive interface.
|
|
15
|
+
|
|
16
|
+
### 📐 Visual Schema Explorer
|
|
17
|
+
Visualize your entire database architecture at a glance. Our grid-based **Schema View** transforms complex table relationships into beautiful, interactive cards with dynamic color-coding.
|
|
18
|
+
|
|
19
|
+
### 📄 Professional PDF Documentation
|
|
20
|
+
Generate high-fidelity database schema reports with a single click. Powered by **Puppeteer** server-side rendering, our exports ensure 100% style accuracy and a professional A4 print layout.
|
|
21
|
+
|
|
22
|
+
### 🔐 Enterprise-Grade Security
|
|
23
|
+
- **Machine-ID Binding**: Licenses are securely tied to unique hardware identifiers.
|
|
24
|
+
- **JWT Authentication**: Secure session management using JSON Web Tokens and HTTP-only cookies.
|
|
25
|
+
- **RSA-256 Verification**: Offline license verification using public/private key pairs.
|
|
26
|
+
|
|
27
|
+
### 🛠️ Developer-First Experience
|
|
28
|
+
- **Customizable Layout**: Toggle between 1-4 column grid views.
|
|
29
|
+
- **View Switching**: Seamlessly jump between raw data and architectural schemas.
|
|
30
|
+
- **Fast Search**: Quickly find the tables and columns you need.
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## 🚀 Quick Start
|
|
35
|
+
|
|
36
|
+
### Prerequisites
|
|
37
|
+
- **Node.js**: v18 or higher
|
|
38
|
+
- **pnpm**: Recommended package manager
|
|
39
|
+
- **MySQL**: Access to a running MySQL instance
|
|
40
|
+
|
|
41
|
+
### Installation
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
# Install dependencies
|
|
45
|
+
pnpm install
|
|
46
|
+
|
|
47
|
+
# Build the application
|
|
48
|
+
pnpm build
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Environment Configuration
|
|
52
|
+
|
|
53
|
+
Create a `.env` file in the root of the `studio-app` directory:
|
|
54
|
+
|
|
55
|
+
```env
|
|
56
|
+
MYSQL_URL=mysql://user:password@localhost:3306/your_database
|
|
57
|
+
LICENSE_SERVER_URL=http://your-license-server.com
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
|
|
62
|
+
## 💻 Tech Stack
|
|
63
|
+
|
|
64
|
+
- **Frontend**: [React 18](https://react.dev/), [React Router 6](https://reactrouter.com/), [Tailwind CSS 3](https://tailwindcss.com/)
|
|
65
|
+
- **Backend**: [Express 5](https://expressjs.com/), [Puppeteer](https://pptr.dev/)
|
|
66
|
+
- **UI Components**: [Radix UI](https://www.radix-ui.com/), [Lucide Icons](https://lucide.dev/)
|
|
67
|
+
- **Database**: [MySQL](https://www.mysql.com/)
|
|
68
|
+
- **Build System**: [Vite](https://vitejs.dev/), [tsup](https://tsup.egoist.dev/)
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## 🏗️ Project Architecture
|
|
73
|
+
|
|
74
|
+
```text
|
|
75
|
+
client/ # Modern React SPA
|
|
76
|
+
├── components/ # Reusable UI & Logic components
|
|
77
|
+
├── pages/ # Route-level components
|
|
78
|
+
└── lib/ # Utilities and API wrappers
|
|
79
|
+
|
|
80
|
+
server/ # Express API & Documentation Engine
|
|
81
|
+
├── index.ts # Main entry point with License & PDF logic
|
|
82
|
+
└── config.ts # Server configuration
|
|
83
|
+
|
|
84
|
+
bin/ # CLI tools for global linking
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## 📑 PDF Export Engine
|
|
90
|
+
|
|
91
|
+
Our export engine doesn't just "print" the page. It uses a sophisticated server-side flow:
|
|
92
|
+
1. **Headless Navigation**: Puppeteer visits a specialized `?export=true` route.
|
|
93
|
+
2. **Adaptive CSS**: The app re-renders specifically for print, enforcing a single-column layout and hiding interactive elements.
|
|
94
|
+
3. **True Fidelity**: Captures full Tailwind colors and styles into a multi-page A4 PDF.
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## 🔒 License & Security
|
|
99
|
+
|
|
100
|
+
This application requires a valid license key for operation. The licensing system uses **RSA-256** signatures to ensure integrity and **Machine-ID** hashing to prevent unauthorized distribution.
|
|
101
|
+
|
|
102
|
+
---
|
|
103
|
+
|
|
104
|
+
*Part of the [Database Studio Workspace](../../README.md).*
|
package/dist/public.pem
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
-----BEGIN PUBLIC KEY-----
|
|
2
|
+
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoNtHPt9FWow0wkX8QszM
|
|
3
|
+
fsS6raS0edOuhkfJYnoMfSHeQ/cBztIV3kTOqu8N2YOzZhPdOFh8b5lBQMyzShXf
|
|
4
|
+
PpvtCjbW0LzkWYiv1ak33RrV9rh2s599toI+sDv/vMv/msB7RHCNEqaIfeeMYdu4
|
|
5
|
+
YrwXOSptGTZPLYe/aitfE4z0ez5P7QR93uZAEftqlODbU/4z4pRcFCwdB2J0+DIR
|
|
6
|
+
Kik1C6Cth/RHAqznVr75VSkiONlX47cFNXny2L4Ujt20wbVyRtErnYdtZDAaVYv7
|
|
7
|
+
ZDHKTqt4L2FyD6WwckqHQwDSUbRjWpMyIwJD7YNg2XSKPldtacuw4VlgD0XaAoM5
|
|
8
|
+
jQIDAQAB
|
|
9
|
+
-----END PUBLIC KEY-----
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "database-studio",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"private": false,
|
|
6
6
|
"bin": {
|
|
@@ -103,7 +103,7 @@
|
|
|
103
103
|
"build:client": "vite build",
|
|
104
104
|
"build:server": "tsup server/index.ts --format cjs --minify --out-dir dist/server --splitting false",
|
|
105
105
|
"build:cli": "tsup bin/cli.ts --format cjs --minify --out-dir dist --splitting false",
|
|
106
|
-
"build": "pnpm build:client && pnpm build:server && pnpm build:cli",
|
|
106
|
+
"build": "pnpm build:client && pnpm build:server && pnpm build:cli && cp public.pem dist/public.pem && cp README.md dist/README.md",
|
|
107
107
|
"start": "node dist/cli.cjs",
|
|
108
108
|
"link:global": "pnpm link --global"
|
|
109
109
|
}
|