Skip to content

ZeroOneStudio/botmate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Botmate

Code Climate Dependency Status

Simple nodejs server to serve static snapshots of single-page apps to crawlers.

Requirements

This guys are required to be present in your PATH:

Usage

First, you need to run botmate server as a daemon. It starts on http://127.0.0.1:3001 by default:

$ git clone https://github.com/ZeroOneStudio/botmate && cd botmate
$ npm install
$ forever start botmate.js

Arter you need to configure your web server to catch requests with _escaped_fragment_ and proxy them to botmate.

Nginx configuration example

location / {
  ...

  if ( $arg__escaped_fragment_ ) {
    proxy_pass http://127.0.0.1:3001/?host=$host$uri&fragment=$arg__escaped_fragment_;
    break;
  }

  ...
}

Restart nginx and you are ready to serve static snapshots to crawlers. Yay!

TODO

  • Cache snapshots
  • Get rid of callback hell, DRY
  • Tests

LICENSE - "MIT License"

Copyright (c) 2010 Zero.One, http://www.zeroone.st

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Simple nodejs server to serve static snapshots of single-page apps to crawlers

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published