https://github.com/kettil/mongoose-management
Mongoose Management Tool
https://github.com/kettil/mongoose-management
database db document model mongodb mongoose nodejs nosql odm orm schema typescript
Last synced: over 1 year ago
JSON representation
Mongoose Management Tool
- Host: GitHub
- URL: https://github.com/kettil/mongoose-management
- Owner: kettil
- License: mit
- Created: 2019-06-12T17:39:44.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-01T19:42:42.000Z (over 3 years ago)
- Last Synced: 2025-02-16T04:29:12.357Z (over 1 year ago)
- Topics: database, db, document, model, mongodb, mongoose, nodejs, nosql, odm, orm, schema, typescript
- Language: TypeScript
- Homepage:
- Size: 1.43 MB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Mongoose Management Tool
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Introduction](#introduction)
- [Building](#building)
- [Tests](#tests)
- [Prettier and Lint](#prettier-and-lint)
## Features
- Manage collections for multiple databases
- Manage your schemas via CLI
- Create columns and indexes
- Generate models with full TypeScript support
## Installation
```bash
npm install --global mongoose-management
```
## Introduction
In your project folder you start the application and follow the menu items.
```bash
mongoose-management
# show the help menu
mongoose-management --help
```
The [example folder](./example) contains an example project. If the application is installed globally, the example project can be called using the following command.
```bash
# on a mac where nodejs is installed via homebrew
mongoose-management -p /usr/local/lib/node_modules/mongoose-management/example
```
### Overview of collections groups
### Overview of collections
### Overview of columns and indexes
### Creating a column
## Building
Compile the application from TypeScript to JavaScript.
The following command is available:
- `npm run build`
Builds the application
## Tests
**The following commands are available:**
| Command | Description |
| ----------------------- | ------------------------- |
| `npm run test` | Run all tests |
| `npm run test:watch` | Watching mode from test |
| `npm run test:coverage` | Creates a coverage report |
## Prettier and Lint
Ensures that the code is formatted uniformly and that the coding standards are adhered to.
The following commands are available:
- `npm run prettier`
Changes the code formatting as defined in the Prettier setting.
- `npm run lint`
Checks if the lint rules are followed. It calls the prettier command first.