shoshinnikita / boltbrowser

boltBrowser is a GUI web-based explorer and editor for boltDB

boltBrowser

boltBrowser is a web-based explorer for BoltDB.

Warning! I need your help. For details see help wanted

Features

• You can work with several databases in one time
• You can visit nested buckets
• Minimalistic and simple interface
• Opportunity to search records and buckets using regex
• Opportunity to edit a db (create, delete, modify buckets and records)

Examples of using the program

How to start

1. Run the program (you can download the latest release here)
2. Go to localhost:500
3. Open the list of databases
4. Add a database by pressing sign '+'
5. Enjoy!

Settings

Setting	Default value	Description
port	:500	port of the website
offset	100	number of records on a single page
debug	false	mode of debugging
check version	true	should program check a new version
open browser	true	should the program open a browser automatically
neat window	true	should the program open a neat window

You can change settings by editing a config file or using command line flags.

Config file

The config file – config.ini. The default content:

# List of all opts:
# port
# debug
# offset
# should_check_version
# is_write_mode
# open_browser
# open_neat_window

# Port for website
port=:500
debug=false
# number of records on a single screen
offset=100
should_check_version=true
is_write_mode=true
open_browser=true
# has effect only if 'open browser' is true
open_neat_window=true

You can overwrite values from the config file by setting flags.

Flags

The default values are the same as values in the config file.

Flag	Description
-port	port of the website
-offset	number of records on single page
-debug	mode of debugging
-checkVer	should program check a new version
-openBrowser	should the program open a browser automatically
-neatWindow	should the program open a neat window

Security

Program use function EscapeString() from package html for preventing of js-injection.

Other

You can change mode of converting []byte. Just change functions ConvertKey(b []byte) string (or ConvertValue()) in src/converters/converter.go

Note: function will be used for converting all keys (or values). So, if your keys (or values) were converted from either string or uint program will crash.

Additional info

Initial work was undertaken on Bitbucket.

Help wanted

Unfortunately, I'm not a good frontend and UI developer. So, it would be great, if you decide to help me.

If you want to help, you can check Issues or you can skim through the source code.

License

MIT License

boltbrowser's Issues

Remove "Back" button if user is in cmd

Originally reported by: Shoshin Nikita (Bitbucket: ShoshinNikita, GitHub: ShoshinNikita)

---

---

• Bitbucket: https://bitbucket.org/ShoshinNikita/boltbrowser/issue/2

Show only part of all records

Show only part of all records. For example, 100.

• Add offset into db.DBApi
• Define constant for offset
• Add buttons "Prev" and "Next"

Use config file instead of flags

Offline usage

Add jQuery and material-icons.

Add images into README.md

Add screenshots of website into README.md

Add opportunity to create a new db

Add timeout of trying to open a db

Not enough storage is available to process this command

Add flag -noConfig

Add flag -noConfig. The program won't create config file or will ignore it, if the file already exists.

Add opportunity to search records by key

Solution:

• Keep all records in memory (we can create array while first call function GetRoot())
• We can use binary search, because all elements are sorted (for PrefixScan()). Think about SuffixScan()
• Add simple realization of regexp (?)

Also, we can use records in memory to increase speed of functions NextRecords() and PrevRecords()

Add tests for frontend

Rewrite frontend part

For issue #38

Improve error messages

Use package github.com/pkg/errors

Parse flags

Originally reported by: Shoshin Nikita (Bitbucket: ShoshinNikita, GitHub: ShoshinNikita)

---

Flag -port change port of website (default 500)

---

• Bitbucket: https://bitbucket.org/ShoshinNikita/boltbrowser/issue/6

Change type of filename input

Change type from <input type="text"> to <input type="file">

Open a browser automatically

The program should open a browser right after launching.

Unable to export values of fields when in read only mode

When in read only mode, trying to export using x or X fails with error database not open or Error Exporting to file {filePath}. It would be nice if there was a way to export values without having to open with read/write access and block other processes.

Add unit-tests

Originally reported by: Shoshin Nikita (Bitbucket: ShoshinNikita, GitHub: ShoshinNikita)

---

---

• Bitbucket: https://bitbucket.org/ShoshinNikita/boltbrowser/issue/3

Use Electron

Add opportunity to edit DB

Opportunities:

• Add buckets
• Remove buckets
• Add records
• Remove records
• Edit records

Add paths to the last several databases into Local Storage

Read-Only mode per every database

Add an option to chose mode (write | read-only) in window of opening a db

Close databases when program is getting SIGTERM of SIGINT

Originally reported by: Shoshin Nikita (Bitbucket: ShoshinNikita, GitHub: ShoshinNikita)

---

---

• Bitbucket: https://bitbucket.org/ShoshinNikita/boltbrowser/issue/4

Editing of the name of a bucket

Use html.EscapeString()

We can use html.EscapeString() instead of changing some symbols (section Security)

Add function of sorting elements by type (buckets before records)

Originally reported by: Shoshin Nikita (Bitbucket: ShoshinNikita, GitHub: ShoshinNikita)

---

---

• Bitbucket: https://bitbucket.org/ShoshinNikita/boltbrowser/issue/7

Add system of checking is there any new versions

Add a module, which checks GitHub on startup and defines is there any new versions

Add wrapper for converting a key and a value

Originally reported by: Shoshin Nikita (Bitbucket: ShoshinNikita, GitHub: ShoshinNikita)

---

Add function for converting a key and value and wrapper for it.
For example:

#!go
func toInt(b []byte) (string, error) { ... }

func toString(b []byte) (string, error) { ... }

---

• Bitbucket: https://bitbucket.org/ShoshinNikita/boltbrowser/issue/5

Embed static files into the binary

Embed .js and .css files into the binary

Make web-interface

Originally reported by: Shoshin Nikita (Bitbucket: ShoshinNikita, GitHub: ShoshinNikita)

---

---

• Bitbucket: https://bitbucket.org/ShoshinNikita/boltbrowser/issue/1

Improve web-design

Fix the interface