Convention for Workspaces

From Chorke Wiki
(Redirected from Chorke Workspaces)
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 of Windows OS. Linux|Unix OS users please update the bash profile as following:

Configuration

@rem windows os user's set the environment variable
────────────────────────────────────────────────────────────────
set ACADEMIA_HOME=%USERPROFILE%\.chorke\academia
set SOFTWARE_HOME=%USERPROFILE%\.chorke\software
set MEDISYS_HOME=%USERPROFILE%\.medisys\medisys
set RAIYAN_HOME=%USERPROFILE%\.shahed\raiyan

rem set ACADEMIA_WSS=%ACADEMIA_HOME%\wss
rem set SOFTWARE_WSS=%SOFTWARE_HOME%\wss
rem set MEDISYS_WSS=%MEDISYS_HOME%\wss
rem set RAIYAN_WSS=%RAIYAN_HOME%\wss
@rem start » command prompt » run as administrator
────────────────────────────────────────────────────────────────
mkdir %ACADEMIA_HOME%
mkdir C:\opt\dev\%USERNAME%\chorke\academia
mklink /D %ACADEMIA_HOME%\wss C:\opt\dev\%USERNAME%\chorke\academia
dir %ACADEMIA_HOME%

Example: 01

@rem start » command prompt » run as administrator
────────────────────────────────────────────────────────────────
mkdir %ACADEMIA_HOME%
mkdir C:\opt\dev\shahed\chorke\academia
mklink /D %ACADEMIA_HOME%\wss C:\opt\dev\shahed\chorke\academia
dir %ACADEMIA_HOME%

Example: 02

@rem start » command prompt » run as administrator
────────────────────────────────────────────────────────────────
mkdir %SOFTWARE_HOME%
mkdir C:\opt\dev\shahed\chorke\software
mklink /D %SOFTWARE_HOME%\wss C:\opt\dev\shahed\chorke\software
dir %SOFTWARE_HOME%

Example: 03

@rem start » command prompt » run as administrator
────────────────────────────────────────────────────────────────
mkdir %MEDISYS_HOME%
mkdir C:\opt\dev\shahed\medisys\medisys
mklink /D %MEDISYS_HOME%\wss C:\opt\dev\shahed\medisys\medisys
dir %MEDISYS_HOME%

Example: 04

@rem start » command prompt » run as administrator
────────────────────────────────────────────────────────────────
mkdir %RAIYAN_HOME%
mkdir C:\opt\dev\shahed\shahed\raiyan
mklink /D %RAIYAN_HOME%\etc C:\opt\dev\shahed\shahed\raiyan
dir %RAIYAN_HOME%
# linux|unix os user's update the bash profile
──────────────────────────────────────────────────────
export ACADEMIA_HOME="$HOME/.chorke/academia"
export SOFTWARE_HOME="$HOME/.chorke/software"
export MEDISYS_HOME="$HOME/.medisys/medisys"
export RAIYAN_HOME="$HOME/.shahed/raiyan"

# export ACADEMIA_WSS="$ACADEMIA_HOME/wss"
# export SOFTWARE_WSS="$SOFTWARE_HOME/wss"
# export MEDISYS_WSS="$MEDISYS_HOME/wss"
# export RAIYAN_WSS="$RAIYAN_HOME/wss"
# linux|unix » login » dashboard » terminal
──────────────────────────────────────────────────────
mkdir -p $ACADEMIA_HOME
mkdir -p /opt/dev/$USER/chorke/academia
ln -s /opt/dev/$USER/chorke/academia $ACADEMIA_HOME/wss
ls -lah $ACADEMIA_HOME

Example: 01

# linux|unix » login » dashboard » terminal
──────────────────────────────────────────────────────
mkdir -p $ACADEMIA_HOME
mkdir -p /opt/dev/shahed/chorke/academia
ln -s /opt/dev/shahed/chorke/academia $ACADEMIA_HOME/wss
ls -lah $ACADEMIA_HOME

Example: 02

# linux|unix » login » dashboard » terminal
──────────────────────────────────────────────────────
mkdir -p $SOFTWARE_HOME
mkdir -p /opt/dev/shahed/chorke/software
ln -s /opt/dev/shahed/chorke/software $SOFTWARE_HOME/wss
ls -lah $SOFTWARE_HOME

Example: 03

# linux|unix » login » dashboard » terminal
──────────────────────────────────────────────────────
mkdir -p $MEDISYS_HOME
mkdir -p /opt/dev/shahed/medisys/medisys
ln -s /opt/dev/shahed/medisys/medisys $MEDISYS_HOME/wss
ls -lah $MEDISYS_HOME

Example: 04

# linux|unix » login » dashboard » terminal
──────────────────────────────────────────────────────
mkdir -p $RAIYAN_HOME
mkdir -p /opt/dev/shahed/shahed/raiyan
ln -s /opt/dev/shahed/shahed/raiyan $RAIYAN_HOME/wss
ls -lah $RAIYAN_HOME

Big Views

Projects

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

Programming

.chorke/academia/wss
   ├─ code_wss
   ├─ core_wss
   ├─ java_wss
   ├─ perl_wss
   ├─ ruby_wss
   └─ zend_wss

Java Workspaces

academia/wss/java_wss/
   ├─ acad_wss
   ├─ agro_wss
   ├─ base_wss
   ├─ cuis_wss
   ├─ ebis_wss
   └─ hims_wss

Workspaces-I

wss/java_wss/base_wss/
   ├─ root_ws
   ├─ base_ws
   ├─ prnt_ws
   ├─ fltr_ws
   ├─ phan_ws
   ├─ exec_ws

Workspace-II

wss/java_wss/base_wss/
   ├─ ecma_ws
   ├─ core_ws
   ├─ test_ws
   ├─ demo_ws
   ├─ make_ws
   └─ exam_ws

Workspaces

ROOT

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


#PRNT
java_wss/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

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


#FLTR
java_wss/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

java_wss/exec_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
java_wss/ecma_wss/core_ws
   ├─ academia-core-filter
   ├─ academia-core-ant.js
   ├─ academia-core-liq.js
   ├─ academia-core-cki.js
   ├─ academia-core-ckicss
   ├─ academia-core-jse.js
   ├─ academia-mvvm-ext.js
   ├─ academia-mvvm-ng.log
   ├─ academia-mvvm-tpl.js
   └─ academia-mvvm-ui.log

EXEC

java_wss/exec_wss/make_ws
   ├─ academia-make-filter
   ├─ academia-make-antcli
   ├─ academia-make-mvncli
   ├─ academia-make-gradle
   ├─ academia-make-ckicli
   ├─ academia-exec-cpmcli
   └─ academia-exec-daemon


#RXTX
java_wss/jnii_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

java_wss/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-make4j
   ├─ academia-core-zproxy
   ├─ academia-core-api.ql
   ├─ academia-core-api.rs
   └─ academia-core-api.ws

TEST

java_wss/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-make4j
   ├─ academia-test-zproxy
   ├─ academia-test-fatjar
   ├─ academia-test-fatwar
   ├─ academia-test-api.ql
   ├─ academia-test-api.rs
   └─ academia-test-api.ws

BOOT

java_wss/apps_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-make4j
   ├─ academia-boot-zproxy
   ├─ academia-boot-fatjar
   ├─ academia-boot-fatwar
   ├─ academia-boot-api.ql
   ├─ academia-boot-api.rs
   └─ academia-boot-api.ws

AMQP

java_wss/apps_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-make4j
   ├─ academia-amqp-zproxy
   ├─ academia-amqp-fatjar
   ├─ academia-amqp-fatwar
   ├─ academia-amqp-api.ql
   ├─ academia-amqp-api.rs
   └─ academia-amqp-api.ws

MQTT

java_wss/apps_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-make4j
   ├─ academia-mqtt-zproxy
   ├─ academia-mqtt-fatjar
   ├─ academia-mqtt-fatwar
   ├─ academia-mqtt-api.ql
   ├─ academia-mqtt-api.rs
   └─ academia-mqtt-api.ws


DEMO

java_wss/apps_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-make4j
   ├─ academia-demo-zproxy
   ├─ academia-demo-fatjar
   ├─ academia-demo-fatwar
   ├─ academia-demo-api.ql
   ├─ academia-demo-api.rs
   └─ academia-demo-api.ws

ARCH

java_wss/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-make4j
   ├─ academia-arch-zproxy
   ├─ academia-arch-fatjar
   ├─ academia-arch-fatwar
   ├─ academia-arch-api.ql
   ├─ academia-arch-api.rs
   └─ academia-arch-api.ws

MAKE

java_wss/apps_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

java_wss/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

$ACADEMIA_HOME/wss/java_wss/base_wss/
──┬─────────────────────────
  ├─ root_ws [academia-java-base-root          ][org.chorke.academia.java.base.root           : academia-root-parent]
  ├─ base_ws [academia-java-base-base          ][org.chorke.academia.java.base.base           : academia-base-parent]
  ├─ core_ws [academia-java-base-core          ][org.chorke.academia.java.base.core           : academia-core-parent]
  │
  ├─ ecma_ws [academia-java-base-ecma          ][org.chorke.academia.java.base.ecma           : academia-ecma-ant.js]
  ├─ ecma_ws [academia-java-base-ecma          ][org.chorke.academia.java.base.ecam           : academia-ecma-cki.js]
  ├─ ecma_ws [academia-java-base-ecma          ][org.chorke.academia.java.base.ecma           : academia-ecma-ckicss]
  │
  ├─ make_ws [academia-java-base-make          ][org.chorke.academia.java.base.make           : academia-make-parent]
  ├─ rxtx_ws [academia-java-base-rxtx          ][org.chorke.academia.java.base.rxtx           : academia-rxtx-parent]
  ├─ arch_ws [academia-java-base-arch          ][org.chorke.academia.java.base.arch           : academia-arch-parent]
  ├─ exec_ws [academia-java-base-exec          ][org.chorke.academia.java.base.arch           : academia-exec-parent]
  ├─ exec_ws [academia-java-base-exec          ][org.chorke.academia.java.base.arch           : academia-exec-clicki]
  ├─ exec_ws [academia-java-base-exec          ][org.chorke.academia.java.base.arch           : academia-exec-daemon]
  └─ demo_ws [academia-java-base-demo          ][org.chorke.academia.java.base.demo           : academia-demo-parent]
$ACADEMIA_HOME/wss/java_wss/ecma_wss/
──┬─────────────────────────
  ├─ core_ws [academia-java-ecma-core          ][org.chorke.academia.java.ecma.core           : academia-core-ant.js]
  ├─ core_ws [academia-java-ecma-core          ][org.chorke.academia.java.ecma.core           : academia-core-cki.js]
  ├─ core_ws [academia-java-ecma-core          ][org.chorke.academia.java.ecma.core           : academia-core-ckicss]
  │
  ├─ core_ws [academia-java-ecma-core-angularjs][org.chorke.academia.java.ecma.core.angularjs :angularjs-core-parent]
  ├─ core_ws [academia-java-ecma-core-sencha   ][org.chorke.academia.java.ecma.core.sencha    :   sencha-core-parent]
  ├─ core_ws [academia-java-ecma-core-reactjs  ][org.chorke.academia.java.ecma.core.reactjs   :  reactjs-core-parent]
  ├─ core_ws [academia-java-ecma-core-vuejs    ][org.chorke.academia.java.ecma.core.vuejs     :    vuejs-core-parent]
  ├─ core_ws [academia-java-ecma-core-graphql  ][org.chorke.academia.java.ecma.core.graphql   :  graphql-core-parent]
  │
  ├─ mvvm_ws [academia-java-ecma-mvvm-angularjs][org.chorke.academia.java.ecma.mvvm.angularjs :  angular-mvvm-parent]
  ├─ mvvm_ws [academia-java-ecma-mvvm-sencha   ][org.chorke.academia.java.ecma.mvvm.sencha    :   sencha-mvvm-parent]
  ├─ mvvm_ws [academia-java-ecma-mvvm-react    ][org.chorke.academia.java.ecma.mvvm.react     :    react-mvvm-parent]
  └─ mvvm_ws [academia-java-ecma-mvvm-vuejs    ][org.chorke.academia.java.ecma.mvvm.vuejs     :    vuejs-mvvm-parent]
$ACADEMIA_HOME/wss/java_wss/exec_wss/
──┬─────────────────────────
  ├─ phan_ws [academia-java-exec-phan          ][org.chorke.academia.java.exec.phan           : academia-phan-parent]
  │
  ├─ make_ws [academia-java-exec-make          ][org.chorke.academia.java.exec.make           : academia-make-antcli]
  ├─ make_ws [academia-java-exec-make          ][org.chorke.academia.java.exec.make           : academia-make-gradle]
  └─ make_ws [academia-java-exec-make          ][org.chorke.academia.java.exec.make           : academia-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
jni    => java native interface
jnii   => java native interface implement
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