1
0
mirror of https://github.com/garraflavatra/rolens.git synced 2025-01-18 13:07:58 +00:00

Added some PR talk

This commit is contained in:
Romein van Buren 2023-06-29 14:37:39 +02:00
parent eba7e84fc8
commit 823ae1328b
Signed by: romein
GPG Key ID: 0EFF8478ADDF6C49
10 changed files with 56 additions and 9 deletions

View File

@ -52,6 +52,31 @@ Rolens is designed to be as intuitive as possible. But if something is unclear n
Feel free to contact me if you have questions! [Send an e-mail.](mailto:romein@vburen.nl)
## Feature list
At this point, Rolens is comparable to MongoHub regarding features. It cannot handle things like user management _yet_, but it _does_ have:
* Connecting to hosts
- Host status
- System info
* Database management
- See stats
- Create dumps with `mongodump`
* Collections
- See stats
- Find, insert, update, & remove
- Save queries to reuse them
- Customizable table view for query results
- Versatile forms to enter data in a standardized format
- Aggregation pipeline editor
- Fully customizable export to a number of formats like JSON, CSV, and Excel
- Index editor
## Wishlist
* User management
* Shell _([under development](https://github.com/garraflavatra/rolens/pull/44))_
## Author and license
© [Romein van Buren](mailto:romein@vburen.nl) 2023. The source code and compiled binaries are released under the GNU GPLv3 license — see [`LICENSE`](./LICENSE) for the full license text.

View File

@ -1,6 +1,7 @@
---
title: Changelog
parent: Development
summary: The development history of Rolens.
parent: Colophon
order: 90
---

View File

@ -1,5 +1,6 @@
---
title: Development
summary: In-depth information about Rolens source code.
order: 50
---

View File

@ -1,5 +1,5 @@
---
title:
title: Rolens
order: 1
summary: Robust, blazing-fast, comprehensive, yet simple [MongoDB](https://www.mongodb.com/) administration tool for Windows, macOS and Linux.
eleventyNavigation:
@ -18,3 +18,11 @@ This project arose from all flaws of similar tools many of which are slow, compl
![Impression of Rolens's interface](./images/home-impression.png)
This project is heavily inspired by the excellent [MongoHub](https://github.com/bububa/MongoHub-Mac) application, which sadly has not been updated since 2011.
## Features
{% filecontent "../README.md", "## Feature list", "## " %}
## Wishlist
{% filecontent "../README.md", "## Wishlist", "## " %}

View File

@ -1,5 +1,6 @@
---
title: Installation
summary: Install Rolens on your machine.
order: 20
---

View File

@ -4,7 +4,7 @@ parent: User guide
order: 100
---
You can open the preference panel by using the menu <kbd>Rolens > Settings…</kbd> or by typing {% render "shortcut", shortcut: shortcuts.preferences[0] %}.
You can open the preference panel by using the menu <kbd>Rolens > Settings…</kbd> or by pressing <kbd></kbd><kbd>,</kbd>.
Rolens currently offers the following configuration options:

View File

@ -103,7 +103,7 @@
</div>
</form>
<Modal title="Advanced aggregation settings" bind:show={settingsModalOpen}>
<Modal title="Advanced aggregation settings" show={settingsModalOpen} on:close={() => settingsModalOpen = false}>
<div class="settinggrid">
<label for="allowDiskUse">Allow disk use</label>
<div class="field">

View File

@ -87,7 +87,7 @@ func (a *App) Menu() *menu.Menu {
helpMenu.AddText("Ask a question", nil, menuCallbackOpenURL(a, "https://github.com/garraflavatra/rolens/discussions/new?category=questions"))
helpMenu.AddSeparator()
helpMenu.AddText("Star Rolens on GitHub", nil, menuCallbackOpenURL(a, "https://github.com/garraflavatra/rolens"))
helpMenu.AddText("Changelog", nil, menuCallbackOpenURL(a, "https://garraflavatra.github.io/rolens/development/changelog/"))
helpMenu.AddText("Changelog", nil, menuCallbackOpenURL(a, "https://garraflavatra.github.io/rolens/colophon/changelog/"))
helpMenu.AddText("License", nil, menuCallbackOpenURL(a, "https://github.com/garraflavatra/rolens/blob/main/LICENSE"))
return appMenu

View File

@ -90,10 +90,21 @@ module.exports = function (eleventyConfig) {
});
// Retrieve content of a file
eleventyConfig.addShortcode('filecontent', function (fname, startLine = 0) {
const buf = fs.readFileSync(path.join(indir, fname));
const str = buf.toString().split('\n').slice(startLine).join('\n');
return str;
eleventyConfig.addShortcode('filecontent', function (fname, a, b) {
let str = fs.readFileSync(path.join(indir, fname)).toString();
if (typeof a === 'number') {
// Line indexes
str = str.split('\n').slice(a, b).join('\n');
}
else if (typeof a === 'string') {
// Anchors
const aIndex = str.indexOf(a) + a.length;
const bIndex = b ? str.indexOf(b, aIndex) : undefined;
str = str.slice(aIndex, bIndex);
}
return str.trim();
});
// Global options