ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2024-12-20 05:37:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[Structure] Add platform structure

Browse Source 
Add general structure for Open MCT Web, including
top-level and second-level directory structure.
README files are included to explain the role of
each directory; markdown is used to allow for
richer display when viewer support is present.

WTD-519.
This commit is contained in:
Victor Woeltjen 2014-10-27 18:17:27 -07:00
parent 89283fc4b1
commit 42bc4599b8
11 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
example/README.md Normal file
View File

@ -0,0 +1,2 @@
This directory is for example bundles, which are intended to illustrate
how to author new software components using Open MCT Web.

2
platform/README.md Normal file
View File

@ -0,0 +1,2 @@
This directory contains all bundles for the Open MCT Web platform, as well
as the framework which runs them.

3
platform/commonUI/README.md Normal file
View File

@ -0,0 +1,3 @@
This directory contains bundles containing common user interface
elements of Open MCT Web; that is, the user interface for the application
as a whole (as opposed to for specific features) is implemented here.

3
platform/core/README.md Normal file
View File

@ -0,0 +1,3 @@
This bundle contains core software components of Open MCT Web. These
components describe MCT's information model, and are responsible for
introducing the API and infrastructure which supports domain objects.

2
platform/data/README.md Normal file
View File

@ -0,0 +1,2 @@
This bundle is responsible for introducing a reusable infrastructure
and set of APIs for using time-series data in Open MCT Web.

3
platform/features/README.md Normal file
View File

@ -0,0 +1,3 @@
This directory contains bundles which represent specific user-facing
features of Open MCT Web, such as plots and other visualizations.
Bundles in this directory should be effectively optional.

3
platform/forms/README.md Normal file
View File

@ -0,0 +1,3 @@
This bundle contains a general implementation of forms in Open MCT Web.
This allows forms to be expressed using a reasonably concise declarative
syntax, and rendered as Angular templates in a consistent fashion.

5
platform/framework/README.md Normal file
View File

@ -0,0 +1,5 @@
Framework-level components for Open MCT Web. This is Angular and Require,
with an extra layer to mediate between them and act as an extension
mechanism to allow plug-ins to be introduced declaratively.

2
platform/identity/README.md Normal file
View File

@ -0,0 +1,2 @@
This bundle is responsible for introducing identity management features
and API to Open MCT Web.

2
platform/persistence/README.md Normal file
View File

@ -0,0 +1,2 @@
This bundle implements a connection to an external CouchDB persistence
store in Open MCT Web.

4
platform/representation/README.md Normal file
View File

@ -0,0 +1,4 @@
This bundle introduces the notion of "representations" to Open MCT Web,
primarily via an Angular directive, `mct-representation`.
A representation is used to display domain objects as Angular templates.