mongoz v0.0.1

🥭 mongoz

Ad hoc MongoDB server for Node.js

Why?

MongoDB is fantastic but setup for small projects can be lots of trouble.

This little package does everything necessary to download and start a fresh mongo server!

Usage

Note: You need to have Node.js and npm already installed!

Note: Make sure there is not already a local mongodb server listening on default port (2701). If you do, either stop it or use PORT environment variable to change the port.

Standalone Server

Let's start a fresh mongoz shall we?

npx mongoz

It will take few seconds on first time of usage to install and extract mongo server.

Programmatic Usage

Do you need a MongoDB server? No problems!

// CommonJS
const { startMongo } = require('mongoz')

// ESM
import { startMongo } from 'mongoz'

// Install and start listening MongoDB on 127.0.0.1:27017 in background
await startMongo()

When closing server, mongo will also gracefully shutdown with node-graceful-shutdown.

In parallel with server

You can also use concurrently to start mongo alongside with server:

package.json:

{
  "scripts": {
    "start": "concurrently 'npx mongoz' 'node ./server.mjs'"
  }
}

Or directly with npx:

npx concurrently 'npx mongoz' 'node ./server.mjs'

Supported platforms

Windows, Linux and Darwin (Mac) are supported. Check formula for details.

Changing data dir

By default, we use a temporary directory to store data and logs. You can customize it with MONGO_DIR environment variable.

License

MIT.

See MongoDB Licensing for underlying server license.