@sqlml/ui 0.3.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ruffiano
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,36 @@
+# @sqlml/ui
+
+SQLML Web UI — Visual database management interface for the SQLML project.
+
+## Structure
+
+- `server/` — NestJS backend API (port 4200)
+- `client/` — React + Vite + Tailwind frontend (port 5173)
+- `docker/` — Docker setup for development databases
+
+## Quick Start
+
+```bash
+# Install dependencies
+npm run install:all
+
+# Start both servers
+npm run dev:server   # Backend on :4200
+npm run dev:client   # Frontend on :5173
+
+# Build for production
+npm run build
+```
+
+## Features
+
+- Dashboard — Overview of database and migrations
+- Schema Editor — Visual DBML editing with Monaco Editor
+- Migrations — View and manage database migrations
+- Database — Connection management
+- Settings — Configuration options
+
+## Data Storage
+
+The UI stores metadata in a local SQLite database at `.sqlml/metadata.db`.
+No external database server is required for the UI itself.