Merge with dongliu master

.eslintignore

@@ -0,0 +1,7 @@
+etc
+sbin
+# !public
+# public/*
+# !public/javascripts
+# public/javascripts/*
+# !public/javascripts/lib

.eslintrc

@@ -10,7 +10,8 @@
   "parserOptions": {
     "ecmaVersion": 2017
   },
-  "extends": ["eslint:recommended", "prettier"],
+
+  "extends": ["airbnb-base", "prettier"],
   "rules": {
     "no-console": 0,
     "quotes": [2, "single", "avoid-escape"],
@@ -21,6 +22,12 @@
     "max-params": [2, 10],
     "operator-assignment": 0,
     "consistent-this": 0,
-    "no-unused-expressions": 1
+    "no-unused-expressions": 1,
+    "no-underscore-dangle": 1,
+    "no-use-before-define": 1,
+    "no-unused-vars": 1,
+    "no-param-reassign": 1,
+    "no-prototype-builtins": 1,
+    "no-continue": 1
   }
 }

.gitignore

@@ -20,6 +20,9 @@ node_modules/
 *.sublime-workspace
 *.idea
 
+# vscode
+.vscode
+
 # system related #
 .DS_Store
 
@@ -42,5 +45,9 @@ config/mongo.json
 config/app.json
 config/alias.json
 
+docker/server.crt
+docker/server.csr
+docker/server.key
+
 # npm stuff #
 npm-debug.log*

.nvmrc

@@ -0,0 +1 @@
+14

Dockerfile

@@ -1,28 +1,20 @@
-FROM node:12-alpine
-RUN apk update && \
-    apk add openssl
+FROM node:20-alpine
+WORKDIR /app
+COPY package.json .
+COPY package-lock.json .
+# RUN apk update && \
+#     apk add openssl
 
 # Add Tini, see https://github.com/krallin/tini for why
 RUN apk add --no-cache tini
 # Tini is now available at /sbin/tini
 ENTRYPOINT ["/sbin/tini", "--"]
 # web port
 EXPOSE 3001
-# api port
-EXPOSE 3443
-
-COPY . /app
-# create the certification file for ssl
-WORKDIR /app/docker
-RUN PASSWORD=$(openssl rand -hex 16) && \
-    openssl genrsa -des3 -passout "pass:${PASSWORD}" -out server.pass.key 2048 && \
-    openssl rsa -passin "pass:${PASSWORD}" -in server.pass.key -out server.key && \
-    rm server.pass.key && \
-    openssl req -new -key server.key -out server.csr \
-        -subj "/C=US/ST=WA/L=Seattle/O=Traveler/OU=Dev/CN=example.com" && \
-    openssl x509 -req -days 365 -in server.csr -signkey server.key -out server.crt
-WORKDIR /app
+# api port if https enabled
+# EXPOSE 3443
 RUN npm install --only=prod
-RUN npm install -g [email protected]
+RUN npm install -g nodemon@2
+COPY . .
 # RUN bower install
 CMD ["node", "app.js"]

LICENSE.md

@@ -1,21 +1,9 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Dong Liu, Dariusz Jarosz
+Copyright (c) 2015
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,130 +1,25 @@
 # Traveler
+The traveler is a Web application to define work templates, create work instances from released templates, and organize the work. 
+## Installation
 
-# Instalation
+### Manual installation (recommended)
 
-For detailed deployment instructions please see https://confluence.aps.anl.gov/display/APSUCMS/Developer+Guide+for+the+Traveler+Module
+Please follow [this instruction](installation-step.md) to install the dependency and traveler application step by step. 
 
-**Deployment of the traveler module:**
+### With script on one box
 
-    # Make a new directory to hold the traveler module and its support
-    mkdir traveler
-    cd traveler
-    git clone https://github.com/AdvancedPhotonSource/traveler.git distribution
-    cd distribution
-    # Install all of the support software
-    make support
-    # Automate configuration of the application
-    make default-config
-    # Navigate to configuration directory
-    cd ../etc/traveler-config
-    # End of output from make dev-config has a list of file(s) that need to be edited
-    nano ad.json
+If you want to install the traveler application and its MongoDB dependency in one Linus box, you can follow [this instruction](installation-script.md).  
 
-**Starting the traveler module:**
+### Local development and test
 
-    # Navigate to the distirbution of the traveler module
-    # When using the support mongodb, start the mongodb part of support
-    ./etc/init.d/traveler-mongodb start
-    # It is good to start the project using node to make sure everything works properly.
-    source setup.sh
-    node app.js
-    # When everything works, start traveler as daemon
-    ./etc/init.d/traveler-webapp start
-    # Check progress of traveler-webapp
-    ./etc/init.d/traveler-webapp status
-
-**Installing docker version (not for production use, but good for development and evaluation)**
+You can quickly set up a standalone environment for the traveler application [with docker](docker.md). This is the best approach for local development or try out before production deployment.  
 
-1. centos docker install (centos) https://docs.docker.com/install/linux/docker-ce/centos/ 
-   * uninstall old docker versions
-   ```
-   sudo yum remove docker \
-                  docker-client \
-                  docker-client-latest \
-                  docker-common \
-                  docker-latest \
-                  docker-latest-logrotate \
-                  docker-logrotate \
-                  docker-selinux \
-                  docker-engine-selinux \
-                  docker-engine
-   ```
-   * install docker CE
-   ```
-   sudo yum install -y yum-utils \
-      device-mapper-persistent-data \
-      lvm2
-   sudo yum-config-manager \
-      --add-repo \
-      https://download.docker.com/linux/centos/docker-ce.repo
-   sudo yum install docker-ce
-   sudo systemctl start docker
-   ```
-   * test docker install
-   ```
-   sudo docker run hello-world
-   ```
-   * configure docker to start on boot
-   ```
-   sudo systemctl enable docker
-   ```
-   * install docker-compose https://docs.docker.com/compose/install/ 
-   ```
-   sudo curl -L "https://github.com/docker/compose/releases/download/1.23.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
-   sudo chmod +x /usr/local/bin/docker-compose
-   sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
-   ```
-   * test docker-compose
-   ```
-   sudo docker-compose --version
-   ```
-2. create docker network for running traveler related apps
-   ```
-   sudo docker network create -d bridge --subnet 172.18.1.0/24 traveler-dev
-   ```
-3. install dependencies
-   * traveler-mongo https://github.com/dongliu/traveler-mongo 
-      * clone git repo
-      ```
-      git clone https://github.com/dongliu/traveler-mongo.git (to e.g., ~/git/traveler)
-      ```
-      * run traveler-mongo
-      ```
-      sudo docker-compose up 
-      ```
-      * access mongo express at http://localhost:8081. The username is traveler, and password is travelerpass.
-   * traveler-ldap https://github.com/dongliu/traveler-ldap 
-      * clone git repo
-      ```
-      git clone https://github.com/dongliu/traveler-ldap.git
-      ```
-      * run
-      ```
-      sudo docker-compose up
-      ```
-      * test
-         * You can check the state of the openladp service via the php ldap admin web https://localhost:6443. There is a default admin account that you can use to log in user name: cn=admin,dc=example,dc=org password: admin
-4. install traveler https://github.com/AdvancedPhotonSource/traveler 
-   * clone git repo
-   ```
-   git clone https://github.com/AdvancedPhotonSource/traveler.git
-   ```
-   * to run and test
-      * must “sudo docker-compose up” traveler-mongo and traveler-ldap as described above first
-      ```
-      sudo docker-compose up
-      ```
-      * URL to run traveler is https://localhost:3001
-      * find a user login in the ldap file traveler-ldap/seed/traveler.ldif
-
-
-# Style and Lint
-
-[prettier](https://prettier.io/) is configured in `prettier.config.js` and `.prettierignore`, and hooked with git at `package.json`. The prettier will process for js, json, css, and md files when the hooked action is triggered via husky. The prettier can be run mannually as
-`./node_modules/prettier/bin-prettier.js --config ./prettier.config.js --write {.,config/**,lib/**,model/**,public/javascripts/**,public/stylesheets/**,routes/**,test/**,utilities/**}/*.{js,json,css,md}` .
-
-Recommend to use [ESLint](http://eslint.org/) to lint the code before committing. The ESLint configuration file is `.eslintrc`.
+## Development
+### Source style and Lint
+We use `eslint` and `prettier` for style and linting. 
 
+## User manual
+See https://dongliu.github.io/traveler-doc/manual for details.
 # License
 
 [MIT](https://github.com/dongliu/traveler/blob/master/LICENSE.md)