XingFramework / xing-backend

Rails engine to generate and consume hypermedia resources as the backend of a Xing project.

The Xing Framework

To learn more about the Xing Framework, read the Xing Book.

Xing Backend

The Xing Framework is a cutting edge web and mobile development platform by Logical Reality Design, Inc. It is designed to provide a completely modern (and even somewhat future-proofed) API + SPA web development platform with sensible defaults, solid conventions, and ease of rapid development. Xing uses Rails (4.2) on the backend and AngularJS (1.4) on the frontend. Most of the problems inherent in getting these two frameworks to talk to each other cleanly have been pre-solved in Xing.

This gem is a Rails Engine that implements the extensions necessary for Rails to function as a Xing back-end API server.

Serializers

TODO:

Subclasses of Xing::Serializers::Base generate hypermedia enabled JSON resources from one or more ActiveModel objects (or other data).

Mappers

TODO:

Subclasses of Xing::Mappers::Base consume incoming hypermedia JSON resources, mapping them to ActiveModel objects for persistence.

Controllers

TODO:

Xing::BaseController contains several helper functions to format correct-to-spec HTTP responses. In a Xing application, your controllers should subclass Xing::BaseController.

Services

TODO: An assortment of utility classes that perform other functions, including:

• Translating ActiveModel/ActiveRecord validation errors into a form suitable for transmitting as a hypermedia error resource.
• Fetching site snapshots from an external server, for SEO purposes.
• Tree lister

Authors

• Evan Dorn
• Patricia Ho
• Judson Lester
• Hannah Howard
• Brooke Fox

The Xing Framework strives to be an open and inclusive project. All Contributors to the Xing Framework must abide by our Code Of Conduct