Shunter is a Node.js application built to read JSON and translate it into HTML.

Shunter works by proxying user requests through to a back-end which responds with JSON; then it uses the JSON as a render context, generating output by passing it into your templates.

• Read the Documentation
• Introduction
• Getting Started
• API Documentation
• Developer Guide
• Migration Guide

Shunter requires Node.js 0.10–5.x, which should come with npm. This should be easy to get running on Mac and Linux.

On Windows things are a bit more complicated due to the Shunter install process requiring a C compiler. Here are some useful links to help you:

• node-gyp Visual Studio 2010 Setup
• contextify – Specified platform toolset (v110) is not installed or invalid

If you're new to Shunter, we recommend our Getting Started Guide. This will teach you the basics, and how to create your first Shunter application.

If you're migrating between major versions of Shunter, we maintain a migration guide to help you.

We maintain a developer guide to help people get started with working on Shunter itself. It outlines the structure of the application and some of the development practices we uphold.

We'd love for you to contribute to Shunter, read the developer guide and get in touch! We also label issues that might be a good starting-point for new developers to the project.

Shunter is licensed under the Lesser General Public License (LGPL-3.0).
Copyright © 2015, Nature Publishing Group