Skip to content

os2display/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OS2display

Table of contents

  1. News
  2. Description
  3. License
  4. Custom Bundles
  5. Templates
  6. Guidelines
  7. Optional extensions
  8. Links

1. News

Keep track of changes in the os2display project: News.md.

2. Description

os2display is a system for creating and delivering content to screens.

It consists of the following parts:

  • admin: the administration website (Symfony / AngularJS)
  • screen: the client that should run on the screen to display the content created in admin (AngularJS)
  • middleware: the connection between admin and screen. The content is pushed from the admin into the middleware that pushes the content to the relevant screens through websockets (node.js).
  • search-node: the search engine used by admin. See https://github.com/search-node/search_node (node.js).
  • docs: the documentation for the project.
  • vagrant: a vagrant development setup. See https://www.vagrantup.com/.

3. License

See License.

4. Custom Bundles

See custom-bundles-guidelines.md for instructions on making custom bundles.

5. Templates

See template-guidelines.md for details concerning templates.

6. Guidelines

Guidelines for developing for os2display

7. Optionals

A number of extensions are available for OS2display:

8. Links