npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

express-rest-mongo

v0.0.22

Published

Mongo prebaked with authentication and a Rest API!

Downloads

7

Readme

express-rest-mongo

NPM version Build Status Coverage Status Total Status

Express setup with Mongo that has basic authentication built in with custom User endpoints. Exposes a mongo database as a rest api. Define your server port number, your mongo port number, your mongo database (which is generated dynamically if needed), and custom routes.

const ExpressRestMongo = require("express-rest-mongo");
const app = new ExpressRestMongo.default({
    port: 3000,
    mongoPort: 27017,
    db: "tempDb"
});
   
app.run();

And, voila! You now have an app running on port 3000 with a full fledge database with basic CRUD endpoints setup for any collection you desire!

Supported endpoints:

  • */getAll
  • */getBy
  • */create
  • */updateById
  • */removeById
  • users/signin
  • users/signup
  • users/updateById

Config options:

  • port: The port your express server will run on, default 3000
  • db: The MongoDB database you will be reading/writing (required)
  • mongoPort: The port of in which mongod is running on, default: 27017
  • mongoIp: The ip address of your mongo instance, default: 127.0.0.1
  • customRoutes: The custom routes you desire to create
  • collections: Array of strings which limits which collections can be read/written to, default: [] To add custom routes, you can define a router and then import it in your config object as customRoutes

Example (with ES6), see the example folder for the code: index.js


import ExpressRestMongo from "../src/express-rest-mongo";

import CustomRoutes from "./custom-routes";

const app = new ExpressRestMongo({
    port: 3000,
    db: "tempDb",
    mongoPort: 27017,
    customRoutes: CustomRoutes
});

app.run();

custom-routes.js

import express from "express";

const CustomRoutes = new express.Router();

CustomRoutes.route("/customers/create").post((req, res) => {
    res.send("This is a custom route!");
});
export default CustomRoutes;

This also supports overriding endpoints as well! So if for some reason you don't like the users/signin or users/signup functionality, you can override it like so.

It's probably a good idea to override users/getAll so that it doesn't give all users to anyone who desires them. By default, all routes are posts, if you want to change that then override the routes