Mongoose Management Tool

Table of Contents

• Features
• Installation
• Introduction
• Building
• Tests
• 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

npm install --global mongoose-management

Introduction

In your project folder you start the application and follow the menu items.

mongoose-management

# show the help menu
mongoose-management --help

The example folder contains an example project. If the application is installed globally, the example project can be called using the following command.

# 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.