Convention for Workspaces

From Chorke Wiki
Revision as of 02:12, 22 June 2020 by Shahed (talk | contribs)
Jump to navigation Jump to search
To maintaining the same ecosystem for the development and production we developed a standard and it will be up to date according to the community demands, missions and visions of Academia. All the contributors and developers of Academia are identified as Academian (Academia + N).
Dear Academian, you are encouraged to use Linux OS (CentOS, Fedora, Debian, Ubuntu or Raspbian), Unix OS (MacOS, FreeBSD or OpenSolaris), GitBash on top of Windows OS (Windows XP, 7, 8 or 10) or any Windows Subsystem for Linux. Before start please set the environment variable permanently for the respective user for Windows OS. For Linux OS or  Unix OS users please update bash profile entries as following:
@rem set windows os user's environment variable
──────────────────────────────────────────────────────
set ACADEMIA_WSS=%USERPROFILE%\chorke\academia

@rem start » command prompt » run as administrator
──────────────────────────────────────────────────────
mkdir %USERPROFILE%\chorke
mkdir D:\opt\dev\chorke\academia
mklink /D %ACADEMIA_WSS% D:\opt\dev\chorke\academia
dir %USERPROFILE%\chorke
# update linux os user's bash profile
──────────────────────────────────────────────────────
export ACADEMIA_WSS="$HOME/chorke/academia"

# linux/unix » login » dashboard » terminal
──────────────────────────────────────────────────────
mkdir -p $HOME/chorke
mkdir -p /opt/dev/chorke/academia
ln -s /opt/dev/chorke/academia $ACADEMIA_WSS
ls -lah $HOME/chorke

Projects

$HOME/chorke/
   ├─ academia
   ├─ agronomy
   ├─ cuisines
   ├─ healthya
   ├─ heritage
   └─ robotica

Programming

./chorke/academia/
   ├─ code
   ├─ core
   ├─ java
   ├─ perl
   ├─ ruby
   └─ zend

Java Workspaces

./chorke/academia/java/
   ├─ acad_wss
   ├─ agro_wss
   ├─ base_wss
   ├─ cuis_wss
   ├─ ebis_wss
   └─ hims_wss

Workspaces-I

./java/base_wss/
   ├─ root_workspace
   ├─ base_workspace
   ├─ prnt_workspace
   ├─ fltr_workspace
   ├─ phan_workspace
   ├─ exec_workspace

Workspace-II

./java/base_wss/
   ├─ ecma_workspace
   ├─ core_workspace
   ├─ test_workspace
   ├─ demo_workspace
   ├─ make_workspace
   └─ exam_workspace

Workspaces

ROOT

./base_wss/root_ws
   ├─ academia-root-parent
   └─ academia-root-filter


#PRNT
./base_wss/prnt_ws
   ├─ academia-root-parent
   ├─ academia-base-parent
   ├─ academia-phan-parent
   ├─ academia-ecma-parent
   ├─ academia-exec-parent
   ├─ academia-rxtx-parent
   ├─ academia-core-parent
   ├─ academia-test-parent
   ├─ academia-boot-paren
   ├─ academia-amqp-parent
   ├─ academia-mqtt-parent
   ├─ academia-demo-parent
   ├─ academia-make-parent
   └─ academia-arch-parent

BASE

./base_wss/base_ws
   ├─ academia-base-parent
   └─ academia-base-filter


#FLTR
./base_wss/fltr_ws
   ├─ academia-root-filter
   ├─ academia-base-filter
   ├─ academia-phan-filter
   ├─ academia-ecma-filter
   ├─ academia-exec-filter
   ├─ academia-rxtx-filter
   ├─ academia-core-filter
   ├─ academia-test-filter
   ├─ academia-boot-filter
   ├─ academia-amqp-filter
   ├─ academia-mqtt-filter
   ├─ academia-demo-filter
   ├─ academia-make-filter
   └─ academia-arch-filter

PHAN

./base_wss/phan_ws
   ├─ academia-phan-filter
   ├─ academia-phan-linx32
   ├─ academia-phan-linx64
   ├─ academia-phan-linarm
   ├─ academia-phan-macx64
   ├─ academia-phan-winx32
   ├─ academia-phan-winx64
   └─ academia-phan-winarm
#ECMA
./base_wss/ecma_ws
   ├─ academia-ecma-filter
   ├─ academia-ecma-ant.js
   ├─ academia-ecma-liq.js
   ├─ academia-ecma-cki.js
   ├─ academia-ecma-ckicss
   ├─ academia-ecma-ext.js
   ├─ academia-ecma-jse.js
   ├─ academia-ecma-ng.log
   ├─ academia-ecma-tpl.js
   └─ academia-ecma-ui.log

EXEC

./base_wss/exec_ws
   ├─ academia-exec-filter
   ├─ academia-exec-antcli
   ├─ academia-exec-mvncli
   ├─ academia-exec-gradle
   ├─ academia-exec-ckicli
   ├─ academia-exec-cpmcli
   └─ academia-exec-daemon


#RXTX
./base_wss/rxtx_ws
   ├─ academia-rxtx-filter
   ├─ academia-rxtx-comapi
   ├─ academia-rxtx-linx64
   ├─ academia-rxtx-linx86
   ├─ academia-rxtx-linarm
   ├─ academia-rxtx-macx64
   ├─ academia-rxtx-winx64
   ├─ academia-rxtx-winx86
   └─ academia-rxtx-winarm

CORE

./base_wss/core_ws
   ├─ academia-core-filter
   ├─ academia-core-enumer
   ├─ academia-core-affirm
   ├─ academia-core-spring
   ├─ academia-core-images
   ├─ academia-core-ttfont
   ├─ academia-core-unijoy
   ├─ academia-core-utlity
   ├─ academia-core-entity
   ├─ academia-core-mypojo
   ├─ academia-core-revert
   ├─ academia-core-persis
   ├─ academia-core-servis
   ├─ academia-core-report
   ├─ academia-core-fusion
   ├─ academia-core-jmxapi
   ├─ academia-core-jse.js
   ├─ academia-core-javaql
   ├─ academia-core-javars
   ├─ academia-core-javaws
   ├─ academia-core-apiapp
   ├─ academia-core-webapp
   ├─ academia-core-launch
   ├─ academia-core-zproxy
   ├─ academia-core-api.ql
   ├─ academia-core-api.rs
   └─ academia-core-api.ws

TEST

./base_wss/test_ws
   ├─ academia-test-filter
   ├─ academia-test-utlity
   ├─ academia-test-change
   ├─ academia-test-entity
   ├─ academia-test-mypojo
   ├─ academia-test-revert
   ├─ academia-test-persis
   ├─ academia-test-servis
   ├─ academia-test-jasper
   ├─ academia-test-report
   ├─ academia-test-fusion
   ├─ academia-test-jmxapi
   ├─ academia-test-jse.js
   ├─ academia-test-javaql
   ├─ academia-test-javars
   ├─ academia-test-javaws
   ├─ academia-test-apiapp
   ├─ academia-test-static
   ├─ academia-test-ui.web
   ├─ academia-test-webapp
   ├─ academia-test-launch
   ├─ academia-test-zproxy
   ├─ academia-test-fatjar
   ├─ academia-test-fatwar
   ├─ academia-test-api.ql
   ├─ academia-test-api.rs
   └─ academia-test-api.ws

BOOT

./base_wss/boot_ws
   ├─ academia-boot-filter
   ├─ academia-boot-utlity
   ├─ academia-boot-change
   ├─ academia-boot-entity
   ├─ academia-boot-mypojo
   ├─ academia-boot-revert
   ├─ academia-boot-persis
   ├─ academia-boot-servis
   ├─ academia-boot-jasper
   ├─ academia-boot-report
   ├─ academia-boot-fusion
   ├─ academia-boot-jmxapi
   ├─ academia-boot-jse.js
   ├─ academia-boot-javaql
   ├─ academia-boot-javars
   ├─ academia-boot-javaws
   ├─ academia-boot-apiapp
   ├─ academia-boot-static
   ├─ academia-boot-ui.web
   ├─ academia-boot-webapp
   ├─ academia-boot-launch
   ├─ academia-boot-zproxy
   ├─ academia-boot-fatjar
   ├─ academia-boot-fatwar
   ├─ academia-boot-api.ql
   ├─ academia-boot-api.rs
   └─ academia-boot-api.ws

AMQP

./base_wss/amqp_ws
   ├─ academia-amqp-filter
   ├─ academia-amqp-client
   ├─ academia-amqp-broker
   ├─ academia-amqp-utlity
   ├─ academia-amqp-change
   ├─ academia-amqp-entity
   ├─ academia-amqp-mypojo
   ├─ academia-amqp-revert
   ├─ academia-amqp-persis
   ├─ academia-amqp-servis
   ├─ academia-amqp-jasper
   ├─ academia-amqp-report
   ├─ academia-amqp-jmxapi
   ├─ academia-amqp-jse.js
   ├─ academia-amqp-javaql
   ├─ academia-amqp-apiapp
   ├─ academia-amqp-static
   ├─ academia-amqp-strict
   ├─ academia-amqp-ui.web
   ├─ academia-amqp-webapp
   ├─ academia-amqp-launch
   ├─ academia-amqp-zproxy
   ├─ academia-amqp-fatjar
   ├─ academia-amqp-fatwar
   ├─ academia-amqp-api.ql
   ├─ academia-amqp-api.rs
   └─ academia-amqp-api.ws

MQTT

./base_wss/mqtt_ws
   ├─ academia-mqtt-filter
   ├─ academia-mqtt-client
   ├─ academia-mqtt-broker
   ├─ academia-mqtt-utlity
   ├─ academia-mqtt-change
   ├─ academia-mqtt-entity
   ├─ academia-mqtt-mypojo
   ├─ academia-mqtt-revert
   ├─ academia-mqtt-persis
   ├─ academia-mqtt-servis
   ├─ academia-mqtt-jasper
   ├─ academia-mqtt-report
   ├─ academia-mqtt-jmxapi
   ├─ academia-mqtt-jse.js
   ├─ academia-mqtt-javaql
   ├─ academia-mqtt-apiapp
   ├─ academia-mqtt-static
   ├─ academia-mqtt-strict
   ├─ academia-mqtt-ui.web
   ├─ academia-mqtt-webapp
   ├─ academia-mqtt-launch
   ├─ academia-mqtt-zproxy
   ├─ academia-mqtt-fatjar
   ├─ academia-mqtt-fatwar
   ├─ academia-mqtt-api.ql
   ├─ academia-mqtt-api.rs
   └─ academia-mqtt-api.ws


DEMO

./base_wss/demo_ws
   ├─ academia-demo-filter
   ├─ academia-demo-utlity
   ├─ academia-demo-change
   ├─ academia-demo-entity
   ├─ academia-demo-mypojo
   ├─ academia-demo-revert
   ├─ academia-demo-persis
   ├─ academia-demo-servis
   ├─ academia-demo-jasper
   ├─ academia-demo-report
   ├─ academia-demo-fusion
   ├─ academia-demo-jmxapi
   ├─ academia-demo-jse.js
   ├─ academia-demo-javaql
   ├─ academia-demo-javars
   ├─ academia-demo-javaws
   ├─ academia-demo-apiapp
   ├─ academia-demo-static
   ├─ academia-demo-ui.web
   ├─ academia-demo-webapp
   ├─ academia-demo-launch
   ├─ academia-demo-zproxy
   ├─ academia-demo-fatjar
   ├─ academia-demo-fatwar
   ├─ academia-demo-api.ql
   ├─ academia-demo-api.rs
   └─ academia-demo-api.ws

ARCH

./base_wss/arch_ws
   ├─ academia-arch-filter
   ├─ academia-arch-utlity
   ├─ academia-arch-change
   ├─ academia-arch-entity
   ├─ academia-arch-mypojo
   ├─ academia-arch-revert
   ├─ academia-arch-persis
   ├─ academia-arch-servis
   ├─ academia-arch-jasper
   ├─ academia-arch-report
   ├─ academia-arch-fusion
   ├─ academia-arch-jmxapi
   ├─ academia-arch-jse.js
   ├─ academia-arch-javaql
   ├─ academia-arch-javars
   ├─ academia-arch-javaws
   ├─ academia-arch-apiapp
   ├─ academia-arch-static
   ├─ academia-arch-ui.web
   ├─ academia-arch-webapp
   ├─ academia-arch-launch
   ├─ academia-arch-zproxy
   ├─ academia-arch-fatjar
   ├─ academia-arch-fatwar
   ├─ academia-arch-api.ql
   ├─ academia-arch-api.rs
   └─ academia-arch-api.ws

MAKE

./base_wss/make_ws
   ├─ academia-make-filter
   ├─ academia-make-antlib
   ├─ academia-make-i4jutl
   ├─ academia-make-boot.i
   ├─ academia-make-amqp.i
   ├─ academia-make-mqtt.i
   └─ academia-make-demo.i

Assessment

EXAM

./base_wss/exam_ws
   ├─ academia-exam-filter
   ├─ academia-exam-change
   ├─ academia-exam-javase
   ├─ academia-exam-sequel
   ├─ academia-exam-dbunit
   ├─ academia-exam-ormhbm
   ├─ academia-exam-ormjpa
   ├─ academia-exam-ormmyb
   ├─ academia-exam-ormmix
   ├─ academia-exam-oop.js
   ├─ academia-exam-oop.ts
   ├─ academia-exam-jse.js
   ├─ academia-exam-ant.js
   ├─ academia-exam-compas
   ├─ academia-exam-less4j
   ├─ academia-exam-jasper
   ├─ academia-exam-javaql
   ├─ academia-exam-javars
   ├─ academia-exam-javaws
   ├─ academia-exam-gui.ng
   ├─ academia-exam-ui.ext
   ├─ academia-exam-ui.jsx
   ├─ academia-exam-ui.vue
   ├─ academia-exam-javaee
   ├─ academia-exam-api.ql
   ├─ academia-exam-api.rs
   └─ academia-exam-api.ws

GitLab Convention

$HOME/chorke/academia/java/base_wss/
──┬────────────────────────────────────
  ├─ root [academia-java-base-root          ][org.chorke.academia.java.base.root           : academia-root-parent]
  ├─ base [academia-java-base-base          ][org.chorke.academia.java.base.base           : academia-base-parent]
  ├─ core [academia-java-base-core          ][org.chorke.academia.java.base.core           : academia-core-parent]
  │
  ├─ ecma [academia-java-base-ecma          ][org.chorke.academia.java.base.ecma           : academia-ecma-ant.js]
  ├─ ecma [academia-java-base-ecma          ][org.chorke.academia.java.base.ecam           : academia-ecma-cki.js]
  ├─ ecma [academia-java-base-ecma          ][org.chorke.academia.java.base.ecma           : academia-ecma-ckicss]
  │
  ├─ make [academia-java-base-make          ][org.chorke.academia.java.base.make           : academia-make-parent]
  ├─ rxtx [academia-java-base-rxtx          ][org.chorke.academia.java.base.rxtx           : academia-rxtx-parent]
  ├─ arch [academia-java-base-arch          ][org.chorke.academia.java.base.arch           : academia-arch-parent]
  ├─ exec [academia-java-base-exec          ][org.chorke.academia.java.base.arch           : academia-exec-parent]
  ├─ exec [academia-java-base-exec          ][org.chorke.academia.java.base.arch           : academia-exec-clicki]
  ├─ exec [academia-java-base-exec          ][org.chorke.academia.java.base.arch           : academia-exec-daemon]
  └─ demo [academia-java-base-demo          ][org.chorke.academia.java.base.demo           : academia-demo-parent]
$HOME/chorke/academia/java/ecma_wss/
──┬────────────────────────────────────
  ├─ core [academia-java-ecma-core          ][org.chorke.academia.java.ecma.core           : academia-core-ant.js]
  ├─ core [academia-java-ecma-core          ][org.chorke.academia.java.ecma.core           : academia-core-cki.js]
  ├─ core [academia-java-ecma-core          ][org.chorke.academia.java.ecma.core           : academia-core-ckicss]
  │
  ├─ core [academia-java-ecma-core-angularjs][org.chorke.academia.java.ecma.core.angularjs :angularjs-core-parent]
  ├─ core [academia-java-ecma-core-sencha   ][org.chorke.academia.java.ecma.core.sencha    :   sencha-core-parent]
  ├─ core [academia-java-ecma-core-reactjs  ][org.chorke.academia.java.ecma.core.reactjs   :  reactjs-core-parent]
  ├─ core [academia-java-ecma-core-vuejs    ][org.chorke.academia.java.ecma.core.vuejs     :    vuejs-core-parent]
  ├─ core [academia-java-ecma-core-graphql  ][org.chorke.academia.java.ecma.core.graphql   :  graphql-core-parent]
  │
  ├─ mvvm [academia-java-ecma-mvvm-angularjs][org.chorke.academia.java.ecma.mvvm.angularjs :  angular-mvvm-parent]
  ├─ mvvm [academia-java-ecma-mvvm-sencha   ][org.chorke.academia.java.ecma.mvvm.sencha    :   sencha-mvvm-parent]
  ├─ mvvm [academia-java-ecma-mvvm-react    ][org.chorke.academia.java.ecma.mvvm.react     :    react-mvvm-parent]
  └─ mvvm [academia-java-ecma-mvvm-vuejs    ][org.chorke.academia.java.ecma.mvvm.vuejs     :    vuejs-mvvm-parent]
$HOME/chorke/academia/java/exec_wss/
──┬────────────────────────────────────
  ├─ phan [academia-java-exec-phan          ][org.chorke.academia.java.exec.phan           :phantomjs-phan-parent]
  │
  ├─ make [academia-java-exec-make          ][org.chorke.academia.java.exec.make           :   apache-make-antcli]
  ├─ make [academia-java-exec-make          ][org.chorke.academia.java.exec.make           :   apache-make-gradle]
  └─ make [academia-java-exec-make          ][org.chorke.academia.java.exec.make           :   apache-make-mvncli]

Abbreviation

amqp   => advanced message queuing protocol
api    => application program interface
api.ql => academia ghql client
api.rs => academia rest client
api.ws => academia soap client
arch   => maven archetype
b2b    => business to business
change => liquibase change logs
code   => xcode for objective c and swift
core   => ms dot net core
dao    => data access object
dto    => data transfer objects
ecma   => ecma script es5, es6 & es7
em     => jpa entity manager
exec   => executable file
fusion => b2b client integration
fltr   => filter workspace
gui    => graphical user interface
gql    => graph ql
ghql   => graph ql
gnuc   => gnu c/c++
javaql => java ghql services
javars => java rest services
javaws => java soap services
jmx    => java management extensions
jmxapi => java management extensions api
jpa    => java persistence api
js     => javascript
jse    => java platform, standard edition
jse.js => javascript runs on jse
jvm    => java virtual machine
myghql => academia graph ql
mypojo => academia pojo
mqtt   => message queuing telemetry transport
orm    => object relational mapping
persis => persistence (dao or repository)
phan   => phantom js
pojo   => plain old java object
prnt   => parent workspace
pu     => jpa persistence unit
pypy   => python
ql     => query language
revert => convert or revert to pojo
servis => academia spring services
ui     => user interface
ui.mob => academia web ui for mobile
ui.tab => academia web ui for tabloid
ui.web => academia web ui for desktop
utlity => academia java utility
webapi => integration of java{ql,rs,ws}
webapp => integration of web{api,gui}
webgui => integration of ui.{mob,tab,web}
vo     => value objects
ws     => workspace
wss    => workspaces
zproxy => zuul proxy server

References