|
1 | | -## SQLite-Viewer |
| 1 | +# SQLite-Viewer |
2 | 2 |
|
3 | | -A web-based SQLite database viewer that runs entirely in the browser. No server required! |
| 3 | +[](https://github.com/bjmdevelopers/SQLite-Viewer/blob/main/LICENSE) |
| 4 | +[](https://bjmdevelopers.github.io/SQLite-Viewer/) |
| 5 | +[](https://github.com/bjmdevelopers/SQLite-Viewer/issues) |
| 6 | +[](https://github.com/bjmdevelopers/SQLite-Viewer/stargazers) |
4 | 7 |
|
5 | | -## Features |
| 8 | +A powerful, 100% client-side SQLite database viewer that runs entirely in your browser. No server, no installation, and no data ever leaves your computer. |
6 | 9 |
|
7 | | -- 🔍 View SQLite database tables and schemas |
8 | | -- 🚀 Powered by WebAssembly (SQLite compiled to WASM) |
9 | | -- 💾 Works offline after initial load |
10 | | -- 🆓 100% client-side - no data leaves your computer |
| 10 | + *A brief demonstration of opening a database and running a query.* |
11 | 11 |
|
12 | | -## How to Use |
| 12 | +## ✨ Features |
13 | 13 |
|
14 | | -1. Open the [live demo](https://bjmdevelopers.github.io/SQLite-Viewer/) |
15 | | -2. Click "Open Database" and select a SQLite `.db` file |
16 | | -3. Browse tables or run custom SQL queries |
| 14 | +- **🖥️ Purely Browser-Based:** Operates entirely on the client-side. Your data stays private. |
| 15 | +- **📂 Open Local `.db` Files:** Directly open and view SQLite database files from your computer. |
| 16 | +- **🔍 Browse Data & Schema:** Intuitively navigate through tables and view their structure. |
| 17 | +- **✏️ Powerful Query Editor:** Execute custom SQL queries with syntax highlighting. |
| 18 | +- **💾 Works Offline:** Fully functional without an internet connection after the initial page load. |
| 19 | +- **🚀 Powered by WebAssembly:** Leverages the power of SQLite compiled to WebAssembly for native-like performance. |
| 20 | +- **📱 Responsive Design:** Use it on your desktop, tablet, or mobile device. |
17 | 21 |
|
18 | | -## Development |
| 22 | +## 🚀 How to Use |
19 | 23 |
|
20 | | -To run locally: |
| 24 | +1. **Navigate** to the [live demo](https://bjmdevelopers.github.io/SQLite-Viewer/). |
| 25 | +2. **Click "Open Database"** and select a SQLite (`.db`, `.sqlite`, `.sqlite3`) file from your local machine. |
| 26 | +3. **Explore your data:** |
| 27 | + * Click on a table name in the sidebar to view its contents. |
| 28 | + * Switch to the "Schema" tab to inspect the table's structure. |
| 29 | +4. **Run Custom Queries:** |
| 30 | + * Go to the "Query" tab. |
| 31 | + * Write your SQL query in the editor. |
| 32 | + * Click "Run Query" to see the results. |
21 | 33 |
|
22 | | -```bash |
23 | | -git clone https://github.com/bjmdevelopers/SQLite-Viewer.git |
24 | | -cd SQLite-Viewer |
25 | | -# Open index.html in your browser |
26 | | -``` |
| 34 | +## 🛠️ Development |
27 | 35 |
|
28 | | -## Technologies Used |
| 36 | +Interested in contributing or running the project locally? |
29 | 37 |
|
30 | | -- SQLite (compiled to WebAssembly) |
31 | | -- Vanilla JavaScript |
32 | | -- HTML5/CSS3 |
| 38 | +1. **Clone the repository:** |
| 39 | + ```bash |
| 40 | + git clone [https://github.com/bjmdevelopers/SQLite-Viewer.git](https://github.com/bjmdevelopers/SQLite-Viewer.git) |
| 41 | + ``` |
| 42 | +2. **Navigate to the project directory:** |
| 43 | + ```bash |
| 44 | + cd SQLite-Viewer |
| 45 | + ``` |
| 46 | +3. **Open `index.html`** in your favorite web browser. That's it! |
33 | 47 |
|
34 | | -## Future Improvements |
| 48 | +## 💻 Technologies Used |
35 | 49 |
|
36 | | -- [ ] Add table editing capabilities |
37 | | -- [ ] Support for importing/exporting data |
38 | | -- [ ] Dark mode toggle |
| 50 | +* **SQLite compiled to WebAssembly (WASM):** This is the core of the application, allowing us to run the SQLite engine directly in the browser with near-native speed. |
| 51 | +* **Vanilla JavaScript:** No frameworks were used, keeping the application lightweight and fast. All interactions and logic are handled with plain JavaScript. |
| 52 | +* **HTML5 & CSS3:** For the application's structure and styling, including the use of Flexbox and Grid for a responsive layout. |
39 | 53 |
|
40 | | -## License |
| 54 | +## 🔮 Future Improvements |
| 55 | + |
| 56 | +We have a lot of exciting features planned: |
| 57 | + |
| 58 | +- **[ ] ✍️ Table Data Editing:** Allow users to directly edit, add, and delete rows. |
| 59 | +- **[ ] 📤 Data Export/Import:** Support for exporting tables or query results to formats like CSV and JSON. |
| 60 | +- **[ ] 🎨 Dark Mode:** A toggle for a more eye-friendly dark theme. |
| 61 | +- **[ ] 📊 Data Visualization:** Basic charting capabilities for query results. |
| 62 | + |
| 63 | +Have an idea? Feel free to [open an issue](https://github.com/bjmdevelopers/SQLite-Viewer/issues)! |
| 64 | + |
| 65 | +## 🤝 Contributing |
| 66 | + |
| 67 | +Contributions are welcome! If you'd like to help improve SQLite-Viewer, please fork the repository and submit a pull request. For major changes, please open an issue first to discuss what you would like to change. |
| 68 | +
|
| 69 | +## 📜 License |
| 70 | +
|
| 71 | +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |
41 | 72 |
|
42 | 73 | MIT © [bjmdevelopers](https://github.com/bjmdevelopers) |
0 commit comments