# kvell-db-plugin-mongoose

> A barebones MongoDB Plugin using Mongoose ORM for kvell-scripts

Latest version **1.0.1-alpha.9.3.1** (published 2020-04-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install kvell-db-plugin-mongoose
pnpm add kvell-db-plugin-mongoose
yarn add kvell-db-plugin-mongoose
bun add kvell-db-plugin-mongoose
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1-alpha.9.3.1 |
| Published | 2020-04-08 |
| First published | 2019-12-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.5 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 17 |
| Author | Neeraj Sharma |
| Maintainers | nsharma1396 |
| Keywords | kvell-plugins, kvell-scripts, create-kvell-app, node, mongoose |

## Links

- npm: https://www.npmjs.com/package/kvell-db-plugin-mongoose
- Repository: https://github.com/nsharma1396/kvell/tree/master/packages/kvell-db-plugin-mongoose
- Homepage: https://kvelljs.now.sh/
- npm.io page: https://npm.io/package/kvell-db-plugin-mongoose

## Dependencies (1)

- [mongoose](https://npm.io/package/mongoose.md) ^5.7.12

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 1.0.1-alpha.9.3.1 (latest) — 2020-04-08
- 1.0.1-alpha.9 — 2020-04-03
- 1.0.1-alpha.8.1 — 2020-03-16
- 1.0.1-alpha.8 — 2020-03-12
- 1.0.1-alpha.7 — 2020-02-06
- 1.0.1-alpha.6.1 — 2020-02-05
- 1.0.1-alpha.6 — 2020-02-05
- 1.0.1-alpha.5 — 2020-01-19
- 1.0.1-1.0.1-alpha.5.0 — 2020-01-19
- 1.0.1-alpha.1 — 2019-12-20
- 1.0.0-alpha.0 — 2019-12-18

## README

# Kvell.js

## What is Kvell ?

[Kvell.js](https://www.github.com/nsharma1396/kvell) is a family of packages using which you can create Node.js applications with pre-defined
configurations, a fixed application flow and a set of abstractions. It bootstraps the node application with a set of popularly used npm packages and provides a minimal setup environment so that the developer can focus directly on writing the essential parts of the application.

## What does it do ?

- Maintains a proper code standard.
- Abstracts out server configurations.
- Abstracts out database related configurations.
- Maintains a consistent top-level folder structure.
- Provides support for writing and viewing API documentations without any setups.
- Provides auto-template creation for routes and models.
- Does automatic git initialization (if possible) on project setup.
- Provides a very simple and basic logging mechanism.

`Kvell` takes inspiration from [create-react-app](https://www.create-react-app.dev) in it's implementation and shares some similarity with `create-react-app's` methodology and internal flow when it comes to how it works under the hood.

# Creating an application

To setup a kvell application, you just need to run the following command

```sh
npx create-kvell-app example-app
```

![create an application](website/docs/assets/create-app.gif)


**Note**: [npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher. If you use npm 5.1 or earlier, you need to install `create-kvell-app` globally instead:


```sh
npm i -g create-kvell-app
```

Once installed, you can create a kvell application by running:

```sh
create-kvell-app example-app
```

## Running the server

Now, you can change your directory to `example-app` and run the application in `development` mode by running:

```sh
cd example-app
npm start
```

That's it! This will start your server on [http://localhost:5001](http://localhost:5001).

![starting the server](website/docs/assets/start-server.gif)

### Disable `watch mode`

The server will by default start with `watch mode` enabled, i.e, it will restart the server everytime you make a change in a file. To run the server without `watch mode`, run the server like so,

```sh
npm start -- --no-watch
```

## Optional Installation Method

You can also create an application using the `npm init` script.

```sh
npm init kvell-app example-app
```

For complete docs of Kvell, visit [Kvell Docs](https://kvelljs.now.sh/)

---
_Source: https://npm.io/package/kvell-db-plugin-mongoose · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._