Git Product home page Git Product logo

azoukr / sqlite-gui-node Goto Github PK

View Code? Open in Web Editor NEW
12.0 1.0 1.0 22.01 MB

sqlite-gui-node is a Node.js package that provides a user-friendly graphical interface for performing CRUD operations on SQLite databases. It simplifies database management tasks by allowing users to interact with SQLite databases through a web-based GUI.

Home Page: https://www.npmjs.com/package/sqlite-gui-node

JavaScript 10.34% EJS 4.11% CSS 77.03% SCSS 0.07% TypeScript 8.45%
gui node node-js nodejs sqlite sqlite-database sqlite3 sqlite3-database sqlite-g

sqlite-gui-node's Introduction

SQLite GUI for Node.js Apps

Version npm npm Downloads

NPM

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 server.

const express = require("express");
// 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");

const app = express();

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

app.listen(4000);

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.

Features

1. CRUD Operations

Perform Create, Read, Update, and Delete operations on your SQLite databases with ease. Our GUI simplifies the process, making database management straightforward and efficient.

  • Create: Add new records to your database tables.
  • Read: Retrieve and view data from your database.
  • Update: Modify existing records.
  • Delete: Remove records from your database.

2. Write Custom Queries

Unleash the full power of SQL by writing your own custom queries, our GUI supports it all.

3. Save Custom Queries

Save your frequently used custom queries for quick access and reuse. This feature helps you streamline your workflow by keeping your important queries organized and readily available.

4. Generate Query Code Using GUI

Generate query code directly from the GUI, saving you time and reducing the risk of syntax errors. Simply design your query using our intuitive interface, and let the GUI generate the corresponding SQL code for you.

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

The MIT License © 2024-present KERIM Abdelmouiz. All rights reserved.


Made with ♥ by KERIM Abdelmouiz

sqlite-gui-node's People

Contributors

azoukr avatar dependabot[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

nnadii

sqlite-gui-node's Issues

Add screenshots

Hi, add a screenshots to a readme, to let potential users see what they will install

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.