Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
titleFramework & Naming conventions

In order to organize the development we have developed a framework and a naming convention for all the repositories of the plateforme that respect :

  • the intelligent system definition provided in the overview
  • the fact that we use npm as our main package manager
  • the necessity to organize the sources of the organs that correspond to web pages in a place where the Spinalhub web server can find and serve them.

Framework

Naming conventions

package name

desciption

exapmles

examples

spinal-core-...

repositories for the hub and javascript connector

spinal-core-hub, spinal-core-connectorJS

spinal-model-...

repositories where the models are defined

spinal-model-graph, spinal-model-visas...

spinal-organ-...

repositories where you define the source of your specific process


spinal-browser-...

repositories where you define the source of your specific web page process that will be served by spinalhub web server (the web browser organs)


spinal-env-...

repositories that contained the source of the prédefined environment provided by spinalcom

spinal-env-drive

spinal-env-admin

spinal-env-viewer

spinal-env-...-plugin-...

repositories where you define the plugin processes that work on top of the environments

spinal-env-drive-plugin-log

spinal-env-viewer-plugin-doc

...

spinal-env-...-join-...

repositories that define how to “join” the environment plugins with the environments