Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/azat-co/mongoui
MongoDB admin UI server written in Node.js 🎮
https://github.com/azat-co/mongoui
database mongodb mongodb-admin mongoui nodejs react webpack
Last synced: about 23 hours ago
JSON representation
MongoDB admin UI server written in Node.js 🎮
- Host: GitHub
- URL: https://github.com/azat-co/mongoui
- Owner: azat-co
- License: mit
- Created: 2013-03-28T01:06:15.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2020-10-16T05:10:08.000Z (about 4 years ago)
- Last Synced: 2024-12-31T23:06:09.504Z (8 days ago)
- Topics: database, mongodb, mongodb-admin, mongoui, nodejs, react, webpack
- Language: JavaScript
- Homepage:
- Size: 45.5 MB
- Stars: 585
- Watchers: 44
- Forks: 132
- Open Issues: 30
-
Metadata Files:
- Readme: readme.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# MongoUI: MongoUI (mongoui) is a web (browser) admin interface for MongoDB.
MongoUI is an open-source web and desktop app which allows to administer local and remote MongoDB instances via GUI. No need to type commands in a terminal anymore. Convenient interface will allow to create, update, remove and filter/search documents. You can switch between collections or even databases with just a single click.
Currently a standalone tool (run as an app locally or on your server); desktop app later. This is a brand new v2 of MongoUI. Old version use DerbyJS, then new version uses Webpack, React, React Router, React Bootstrap and of course Express and Node.
MongoUI v2 looks like this ([gif](https://raw.githubusercontent.com/azat-co/mongoui/master/mongoui.gif)):
Here's another short [**video**](https://vimeo.com/222012000) that shows filtering, editing, and switching collections:
[](https://vimeo.com/222012000)
---
## Why
Tired of typing `db.users.findOne({_id:ObjectId(...)})` just to look up data structure. Even more typing to modify the data. Not happy with the user experience of other MongoDB admin tools?
Meet MongoUI! Alternative to [exprss-mongo](https://github.com/andzdroid/mongo-express) and [Robomongo](https://robomongo.org).
---
## Installation
```
npm i -g mongoui
mongoui
```
## Dev Installation
### Download MongoUI
SSH:
```bash
git clone [email protected]:azat-co/mongoui
npm i
```
or HTTPS
```bash
git clone https://github.com/azat-co/mongoui.git
```
or CURL
```
curl -O https://github.com/azat-co/mongoui/archive/master.zip
```
or WGET
```
wget https://github.com/azat-co/mongoui/archive/master.zip
unzip master.zip
cd mongoui-master
```
### Install Dependencies
```
npm i
```
---
## Usage
### Build and Run MongoUI in Regular Mode
```
npm start
```
Then, open in your favorite browser. Enjoy!
### Build and Run MongoUI in Development (Hot-Reload) Mode
Front-end development in one terminal:
```
npm run start-dev
```
Open in your favorite browser.
Note: there are two ports, 3001 and 3000. In dev mode you need to go to 3000, in regular mode, navigate to 3001. This is because in dev mode, we are using webpack dev server on 3000 and the API (index.js) is alway on 3001.
---
## Additional Tasks
You'll need MongoDB running for MongoUI to work:
```
mongod
```
Front-end build:
```
npm run build
```
### Configs
Configurations are in the `config.json` file. Modify as needed (remote databases should work just fine!).
```js
{
"database": {
"default": {
"host": "localhost",
"port": 27017,
"name": "mongoui",
"username": "",
"password": ""
}
}
}
```
## Branches
* Master — major releases, main branch
* Develop — current development branch (make your pull requests here)
## Contributors
Via `git shortlog -s -n`:
```
83 azat-co
67 Azat Mardan
65 Azat Mardanov
26 Tom2277
14 cultofmetatron
12 Will Hart
1 Sam Tobia
1 Jan Carlo Viray
```
## TODO
The list is in the GitHub Issues.
How to contribute in the CONTRIBUTING.md
### Running Tests
In order to run the tests which are in `test` folder, you will need:
* Node.js
* NPM
With those installed, running `npm install` and ''npm test'' will run the tests.
## Non-node.js alternatives
* Mac OS X app: [MongoHub](http://mongohub.todayclose.com/)
* .NET based app: MongoVUE](http://www.mongovue.com/)
## License
License is in LICENSE.md