mirror of
https://github.com/garraflavatra/rolens.git
synced 2024-11-21 22:18:59 +01:00
Added some documentation
This commit is contained in:
parent
620961266f
commit
9f2445e596
29
README.md
29
README.md
@ -6,18 +6,33 @@ Robust, blazing-fast, comprehensive, yet simple [MongoDB](https://www.mongodb.co
|
||||
|
||||
## Why another MongoDB client?
|
||||
|
||||
This project arose from all flaws of similar tools: they are slow, complicated, heavy, and fairly unwieldy. They require a high level of knowledge on how to operate the program.
|
||||
This project arose from all flaws of similar tools many of which are slow, complicated, heavy, and fairly unwieldy. They mostly require a reasonably high level of knowledge on how to operate the program.
|
||||
|
||||
**Rolens aims to be the intuitive, lightweight counterpart of these overengineered tools.**
|
||||
|
||||
- [x] **Lightweight**: Rolens weighs about 15 MB.
|
||||
- [x] **Open source**: you know what's inside!
|
||||
- [x] **Low overhead**: typical query results against a local database are returned whithin milliseconds.
|
||||
- [x] **Intuitive**: you know MongoDB? You know Rolens.
|
||||
- [x] **Open source**: You know what's inside!
|
||||
- [x] **Low overhead**: Typical query results against a local database are returned whithin milliseconds.
|
||||
- [x] **Intuitive interface**: You know MongoDB? You know Rolens.
|
||||
|
||||
This project is heavily inspired by the excellent [MongoHub](https://github.com/bububa/MongoHub-Mac) application, which sadly has not been updated since 2011.
|
||||
|
||||
## Download and installation
|
||||
|
||||
WIP.
|
||||
Rolens can run on the following operating systems:
|
||||
|
||||
* Windows 10/11 amd64/arm64
|
||||
* Linux amd64/arm64
|
||||
* macOS 10.13+ amd64 (Intel)
|
||||
* macOS 11.0+ arm64 (Apple Silicon)
|
||||
|
||||
### Pre-compiled binaries
|
||||
|
||||
You can obtain a pre-compiled Rolens binary for macOS or installer for Windows from the [release page](https://github.com/garraflavatra/rolens/releases/latest).
|
||||
|
||||
### Compiling from source
|
||||
|
||||
Please refer to the [documentation](./wip) for detailed compilation instructions.
|
||||
|
||||
## User guide
|
||||
|
||||
@ -29,8 +44,8 @@ WIP.
|
||||
* Would you like to see a new **feature**? You can [request it](https://github.com/garraflavatra/rolens/issues/new?assignees=garraflavatra&labels=enhancement&projects=&template=feature.yml).
|
||||
* Do you have a **question**? Ask questions on [the discussion board](https://github.com/garraflavatra/rolens/discussions/new?category=questions).
|
||||
|
||||
Feel free to contact me if you have questions! [send me an e-mail](mailto:romein@vburen.nl)
|
||||
Feel free to contact me if you have questions! [Send an e-mail.](mailto:romein@vburen.nl)
|
||||
|
||||
## Author and license
|
||||
|
||||
© [Romein van Buren](mailto:romein@vburen.nl) 2023. Licensed under the GNU GPLv3 license — see [LICENSE](./LICENSE) for the full license text.
|
||||
© [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.
|
||||
|
37
docs/installation.md
Normal file
37
docs/installation.md
Normal file
@ -0,0 +1,37 @@
|
||||
---
|
||||
title: Installation
|
||||
---
|
||||
|
||||
## System requirements
|
||||
|
||||
Rolens can run on the following operating systems:
|
||||
|
||||
* Windows 10/11 amd64/arm64
|
||||
* Linux amd64/arm64
|
||||
* macOS 10.13+ amd64 (Intel)
|
||||
* macOS 11.0+ arm64 (Apple Silicon)
|
||||
|
||||
## Pre-compiled binaries
|
||||
|
||||
You can obtain a pre-compiled Rolens binary for macOS or installer for Windows from the [release page](https://github.com/garraflavatra/rolens/releases/latest).
|
||||
|
||||
## From source
|
||||
|
||||
Rolens is open-source software, which means that you can compile it from source on your own machine by cloning [the repository](https://github.com/garraflavatra/rolens) and running `make`.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Rolens is written in Go, so you should download the Go compiler from [the download page](https://go.dev/dl/). The minimum version required is 1.18. You can confirm whether it's installed correctly by running `go version` and checking that it outputs something similar to `go1.18.2`.
|
||||
|
||||
In order to compile the frontend, [Node.js](https://nodejs.org/en/download) ^16.0 and the [npm](https://npmjs.com) package manager ^8.0 (included in Node.js) are required. To confirm the installed versions of those tools, execute `node -v` and `npm -v`.
|
||||
|
||||
### Download source
|
||||
|
||||
To obtain a copy of the source code, do either of the following:
|
||||
|
||||
* Download a tarball or zip archive from the [release page](https://github.com/garraflavatra/rolens/releases/latest). Make sure you download the source archive, and not a pre-compiled binary.
|
||||
* Or clone [the Git repository](https://github.com/garraflavatra/rolens): `git clone git clone https://github.com/garraflavatra/rolens.git`.
|
||||
|
||||
### Compile
|
||||
|
||||
`cd` into the root directory of the source code and run `make`. The generated binary will live in `build/bin`. You may want to run the installer (Windows) or move the app to the Applications folder (Mac).
|
Loading…
Reference in New Issue
Block a user