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

naive-mvc

v0.1.0

Published

Simple MVC middleware for express

Downloads

3

Readme

NaiveMVC

Simple MVC middleware for express. Inspired by .NET MVC framework.

Install

$ npm install naive-mvc

Simple Usage

var express = require('express');
var naivemvc = require('naive-mvc')(express);

var app = express();
app.use(naivemvc()); // Then use as middleware

Project Structure

Let's assume you have the following project layout

|-- areas
|   |-- api_v1
|   |   |-- controllers
|   |   |   |-- values.js
|   |   |-- index.js
|-- controllers
|   |-- index.js
|   |-- account.js
|-- views
|   |-- index
|   |   |-- index.html
|   |-- account
|   |   |-- login.html
|   |   |-- login_success.html
|-- app.js

Controller

// controllers/index.js

module.exports = function(router) {
    // GET /
    router.get('/', function(req, res, next) {
        res.render('index', {data: 'Hello World!'}); // no need to specify path of the view file
    });
};
// controllers/account.js

module.exports = function(router) {
    // GET /account/login
    router.get('/login', function(req, res, next) {
        res.render('login');
    });

    // POST /account/login
    router.post('/login', function(req, res, next) {
        // TODO: Verify login credentials
        res.render('login_success');
    });
};

Area

To register an area, do the following

// areas/api_v1/index.js

var naivemvc = require('naive-mvc');

module.exports = function(router) {
    router.use('/api/v1', naivemvc({basePath: __dirname}); // You must supply basePath here
};
// areas/api_v1/controllers/values.js

module.exports = function(router) {
    // GET /api/v1/values
    router.get('/', function(req, res, next) {
        res.jsonp(['value1', 'value2']);
    });
};
  • Note: You must supply basePath options when registering an area *

API

naivemvc([options], [callback])

Shorthand method for calling naivemvc.registerAllControllers and naivemvc.registerAllAreas together.

app.use(naivemvc());

Return

Express.Router

Options

  • basePath {String} (default: path.dirname(require.main.filename)): base path for controller, view and area directories
  • controllerPath {String} (default: basePath + '/contollers'): directory that hold controller files
  • viewPath {String} (default: basePath + '/views'): directory that hold view files
  • areaPath {String} (default: basePath + '/areas'): directory that hold areas
  • viewEngine {String} (default: 'jade'): view engine
  • defaultDocument {String} (default: 'index'): default name of index file
  • params {Array}: Parameters that passed to every controllers

A note on using * params *

If you specific params in options, they are passed to every controller

Examples

// app.js

var db = require('db');

app.use(naivemvc({
    params: [db]
}));
// controllers/account.js

module.exports = function(router, db) {
    // GET /account/id
    router.post('/:id', function(req, res, next) {
        db.users.findOne({_id: req.param.id}, function(err, user){
            if (user) {
                res.render('user', {user: user});
            } else {
                res.render('not_found');
            }
        });
    });
};

naivemvc.registerAllControllers([options], [callback])

Scan controllers directory and register all controllers

app.use(naivemvc.registerAllControllers());

Return

Express.Router

Options (see naivemvc())

  • basePath
  • controllerPath
  • viewPath
  • viewEngine
  • defaultDocument
  • params

naivemvc.registerAllAreas([options], [callback])

Scan areas directory and register all areas

app.use(naivemvc.registerAllAreas());

Return

Express Application

Options (see naivemvc())

  • basePath
  • areaPath
  • params

License

MIT