Skip to content

digideskio/shunter

 
 

Repository files navigation

Shunter

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

It helps you create a decoupled front end which can serve traffic from one or more back end applications - great for use in multi-language, multi-disciplinary teams or just to make your project more flexible and future-proofed.

NPM version Node.js version support Build status Dependencies LGPL-3.0 licensed

Key Features

  • Enforces decoupling of templates from underlying applications
  • Enables multiple applications to use the same unified front end
  • Makes full site redesigns or swapping out back end applications a doddle
  • Completely technology-agnostic; if your application outputs JSON, it can work with Shunter
  • Asset concatenation, minification, cache-busting, and other performance optimisations built-in
  • Outputs any type of content you like, e.g. HTML, RSS, RDF
  • Well-tested and supported, serving Scientific American as well as many high-traffic sites across nature.com

Getting Started

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

You can also refer to the API Documentation for a full breakdown about how to work with Shunter.

Requirements

Shunter requires Node.js 4.x–6.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:

Support and Migration

Shunter major versions are supported for 6 months after their last release. This means that patch-level changes will be added and bugs will be fixed. We maintain a support guide which documents the major versions and their support levels.

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

Contributing

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.

License

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

About

A Node.js application built to read JSON and translate it into HTML

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 97.8%
  • CSS 1.3%
  • Other 0.9%