node-ajax-seo

node-ajax-seo

Simple node plugin that deals with the most popular crawlers, redirecting them to static directory and serving fresh pages to human users. It doesn't generate your snapshots.

Installation

npm install node-ajax-seo --save

Usage

var ajaxSeo = require("node-ajax-seo");

app.get("/*", function(req, res,next) {

    /**
     * It's necessary to define a pattern that matches with not ajax requests:
     * In this case all the paths are ajax except:
     *
     * - /admin and /api paths.
     * - resource requests.
     * - root
     **/

    var siteConfig = {
        ajaxCondition:{
            pattern: /((^\/admin)|(^\/api)|(\.)|(^\/$))/			// you can specify the condition using regex or typical if condition
            //toEval: "(req.url.indexOf('.') == -1 && req.url != '/' && req.url.indexOf('/admin') == -1)"
        },
        indexPath: path.join(__dirname, 'assets', 'index.html'), 	// your main angular .html by default
        staticPages: {
            path: path.join(__dirname, 'assets', 'dist', 'static'),	// path to your static files
            separator: "[---]",										// in your static files, the filenames contain some token replacing "/" path.
            basePath: {
                url: "/",
                file: "home.html"									// the url basepath is an special case
            }
        },
    	debug: false												// false by default
    };

    ajaxSeo.dealWithAjax(siteConfig, req, res, next, function cbk(err) {
        if (err) {
            console.log(err);

            // if we don't have snapshot, we can serve 404 page, log miss request into DB, send a mail... whatevevr,
            // but the best option in this case is to generate it and serve it on-the-fly (WIP).
            console.log(siteConfig.appPrefix+"We serve the  default file caused by the inexistence of the requested one.");
            //res.status(err.status).end();
            res.sendfile(path.join(siteConfig.staticPages.path,siteConfig.staticPages.basePath.file));
        }
        else {
            console.log(siteConfig.appPrefix+'Sent:', path.join(filePath,fragment));
        }
    });
});

Tests

npm test (not yet)

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.

Authors

Eric Lara and Santi Pérez, powered by Ondho.

License

MIT

Roadmap

• connect with static page generator (WIP)

Changelog

1.0.0 (2015-01-13)

Update json config to allow devs customize some options doing it more suitable for general purposes.