Skip to content

Commit cb431f1

Browse files
authored
Update README.md
1 parent a18ac9a commit cb431f1

File tree

1 file changed

+72
-1
lines changed

1 file changed

+72
-1
lines changed

README.md

Lines changed: 72 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,72 @@
1-
# sqlite-browser
1+
# SQLite Browser
2+
3+
SQLite Browser is a web-based SQLite database browser that allows you to load, execute SQL queries, and view results directly in your browser. It is designed to work with SQLite `.db` files, enabling users to interact with their SQLite databases via a user-friendly interface.
4+
5+
## Features
6+
7+
- Load SQLite `.db` files
8+
- Execute SQL queries and view results in table format
9+
- Browse tables in the database
10+
- Save modified databases
11+
- SQL editor with syntax highlighting
12+
- Supports exporting the database to a file
13+
14+
![SQLite Browser](demo.jpg)
15+
16+
## Installation
17+
18+
1. Clone the repository:
19+
```bash
20+
git clone https://github.com/BaseMax/sqlite-browser.git
21+
cd sqlite-browser
22+
```
23+
24+
2. Install dependencies:
25+
```bash
26+
npm install
27+
```
28+
29+
3. Start the server:
30+
```bash
31+
node serve.js
32+
```
33+
34+
4. Open the browser and navigate to `http://localhost:4848/`.
35+
36+
## Usage
37+
38+
- Load a database: Use the file input at the top to load an SQLite .db file.
39+
- Execute SQL: Write your SQL query in the editor and click "Execute SQL".
40+
- Save the database: After making changes, click "Save Database" to download the modified .db file.
41+
- Browse tables: Click on any table name in the list to populate the editor with a SELECT query for that table.
42+
43+
## File Structure
44+
45+
```
46+
.
47+
├── client
48+
│ ├── assets
49+
│ │ ├── css
50+
│ │ │ ├── bootstrap.min.css
51+
│ │ │ ├── codemirror.min.css
52+
│ │ │ └── custom.css
53+
│ │ └── js
54+
│ │ ├── bootstrap.min.js
55+
│ │ ├── codemirror.min.js
56+
│ │ ├── popper.min.js
57+
│ │ ├── script.js
58+
│ │ ├── sql-wasm.wasm
59+
│ │ ├── sql.min.js
60+
│ │ └── worker.sql-wasm.js
61+
│ └── sqlite_browser_ui.html
62+
├── LICENSE
63+
├── README.md
64+
├── serve.js
65+
└── .git
66+
```
67+
68+
### License
69+
70+
This project is licensed under the MIT License - see the LICENSE file for details.
71+
72+
Copyright © 2025 Max Base

0 commit comments

Comments
 (0)