Package Exports

sqlite-gui-node
sqlite-gui-node/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (sqlite-gui-node) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

SQLite GUI for Node.js Apps

Installation
Using a Custom Port
Arguments
Updating the Package
Uninstallation
Screenshots

Installation

To use sqlite-gui-node, you need to have Node.js installed on your machine. You can download Node.js from nodejs.org.

Step 1: Install the Package

You can install sqlite-gui-node using npm (Node Package Manager). Run the following command in your terminal:

$ npm install sqlite-gui-node

Step 2: Import and Initialize

After installing the package, you can import it in your index file of your project.

// import the SQLite DB that you use
const sqlite3 = require("sqlite3").verbose();
const db = new sqlite3.Database("app.db");
// Import the package
const SqliteGuiNode = require('sqlite-gui-node');

...

// use the GUI
SqliteGuiNode(db).catch((err) => {
  console.error("Error starting the server:", err);
});

// Start the server and listen on the specified port
server.listen(port, () => {
  logger.info(`Server is running on ${port}`);
});

Step 3: Access the GUI

Once the GUI is started, you can access it via a web browser. By default, it runs on http://localhost:8080. Open your browser and navigate to this URL to start performing CRUD operations on your SQLite database.

Using a Custom Port

If you want to use a specific port, you can pass it as the second argument when initializing sqlite-gui-node:

// Pass the port as the second argument
SqliteGuiNode(db, 3005).catch((err) => {
  console.error("Error starting the server:", err);
});

Arguments

Argument	Type	Description
db	`sqlite3.Database`	The file of your SQLite database.
port	number	(Optional) The port on which the GUI server will run. Default is `8080`.

Updating the Package

To update sqlite-gui-node to the latest version, you can run:

$ npm update sqlite-gui-node

Uninstallation

If you need to uninstall sqlite-gui-node, you can do so by running:

$ npm uninstall sqlite-gui-node

Screenshots

Display Create table Costum query Edit

Troubleshooting

If you encounter any issues during installation or usage, please refer to the Issues section on GitHub.

License

Made with ♥ by KERIM Abdelmouiz