README
¶
Shelf
Shelf provides a number of open source services that can be used to power community (comments, forms, etc.) on a site (e.g., a blog or newsroom site). More specifically, Shelf is a configurable service layer that publishes endpoints against functionality for:
- mongo aggregation pipeline queries.
- importing, formatting, and validation of data.
- management of relationships between pieces of data.
- management and generation of views of imported data.
The individual services providing these functionalities can be built from the cmd directory as daemons (powering JSON APIs) or CLI tools. The services are as follows:
xenia/xeniad- allows a user to query a collection or a "view" of data via mongo aggregation pipeline queriessponge/sponged- allows a user to import data into a "items" collection and infer relationships between the imported data and other data in the "items" collection.wire- allows a user to create a "view" of data based on inferred relationships.askd- allows a user to create forms and manage submissions to those forms.corald- proxies some of the endpoints exposed by the above services and serves as a central point for interaction with the platform services (assuming you are running more than one of the above).
All of the Shelf documentation (including installation instructions) can be found in the Coral Project Documentation.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
askd
Askd is a web service for handling form related calls.
|
Askd is a web service for handling form related calls. |
|
askd/handlers
Package handlers contains the handler logic for processing requests.
|
Package handlers contains the handler logic for processing requests. |
|
corald
Coral is a web service for handling all calls to the Coral system.
|
Coral is a web service for handling all calls to the Coral system. |
|
corald/handlers
Package handlers contains the handler logic for processing requests.
|
Package handlers contains the handler logic for processing requests. |
|
sponge
This program provides a set of commands for item functionality.
|
This program provides a set of commands for item functionality. |
|
sponged
Sponged is a web service for handling query related calls.
|
Sponged is a web service for handling query related calls. |
|
sponged/handlers
Package handlers contains the handler logic for processing requests.
|
Package handlers contains the handler logic for processing requests. |
|
wire
This program provides a set of commands for relationship/view functionality.
|
This program provides a set of commands for relationship/view functionality. |
|
xenia
This program provides the coral project xenia central CLI platform.
|
This program provides the coral project xenia central CLI platform. |
|
xeniad
Xeniad is a web service for handling query related calls.
|
Xeniad is a web service for handling query related calls. |
|
xeniad/handlers
Package handlers contains the handler logic for processing requests.
|
Package handlers contains the handler logic for processing requests. |
|
internal
|
|
|
platform/db
Package db abstracts different database systems we can use.
|
Package db abstracts different database systems we can use. |
|
platform/db/cayley
Package cayley provides support for the cayley Graph DB with a Mongo backend.
|
Package cayley provides support for the cayley Graph DB with a Mongo backend. |
|
platform/db/mongo
Package mongo provides support for using MongoDB.
|
Package mongo provides support for using MongoDB. |
|
sponge
Package sponge provides support for item importing.
|
Package sponge provides support for item importing. |
|
wire
Package wire provides support for generating views.
|
Package wire provides support for generating views. |
|
xenia
Package xenia provides support for executing Sets and their different types of commands.
|
Package xenia provides support for executing Sets and their different types of commands. |
|
xenia/mask
Package mask provides the service layer for managing masks that need to be applied to results before they are returned.
|
Package mask provides the service layer for managing masks that need to be applied to results before they are returned. |
|
xenia/query
Package query provides the service layer for building apps using query functionality.
|
Package query provides the service layer for building apps using query functionality. |
|
xenia/regex
Package regex provides the service layer for building apps using regex functionality.
|
Package regex provides the service layer for building apps using regex functionality. |
Click to show internal directories.
Click to hide internal directories.