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.
- styleguide: a display of the available UI elements in admin.
- vagrant: a vagrant development setup. See https://www.vagrantup.com/.
See License.
The admin (as of v4.0.0) is in a state of change. The angular code for the admin is moving from a monolithic angular app into seperate apps each concerned with a small part of the administration. The apps each communicate through a bus (busService) where events are emitted and received. This is a change that will be ongoing until all the functionality from the legacy app has been moved into seperate apps.
This change has been introduced to make the code pluggable and more readable. But while the legacy app still exists making changes to the system will be harder.
On the styling front the styleguide has been introduced. The goal is to have all elements that are used in admin exist in the styleguide. The styling from the styleguide is copied to the admin. This means that if new elements are introduced they should be implemented in the styleguide first and then compiled and copied to the admin.
At the moment we have a lot of legacy sass in the web/sass/ folder of the admin.
It is possible to extend os2display with new templates. These should be placed in the web/templates/[organization]/ folder. See template-guidelines.md for details concerning templates.
Guidelines for developing for os2display
- Code of Conduct
- Code standards
- GIT guidelines
- CSS guidelines
- Javascript guidelines
- Template guidelines
See todo.md for a list of todos and feature requests.
- See CHANGELOG.md for a list of changes.
- See installation guide for instructions on how to install os2display.
- See Release process.md for how releases are made.
- See upgrade.md for instructions on how to upgrade between versions.