Big upgrade and merge of PR

.codeclimate.yml

@@ -1,4 +1,4 @@
 languages:
   JavaScript: true
 exclude_paths:
-- "public/js/bootstrap-datepicker.js"
+  - "public/js/bootstrap-datepicker.js"

.dockerignore

@@ -0,0 +1,5 @@
+.git
+.github
+.vscode
+docs
+config/app.json

.editorconfig

@@ -0,0 +1,15 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.js]
+quote_type = single

.eslintrc.json

@@ -0,0 +1,33 @@
+{
+    "env": {
+        "browser": true,
+        "commonjs": true,
+        "es2021": true
+    },
+    "extends": [
+      "standard",
+      "prettier",
+      "plugin:mocha/recommended"
+    ],
+    "parserOptions": {
+        "ecmaVersion": "latest"
+    },
+    "plugins": [
+      "mocha"
+    ],
+    "rules": {
+      "camelcase": 0,
+      "space-before-function-paren": 0,
+      "arrow-body-style": ["error", "as-needed"],
+      //"prefer-arrow-callback": [
+      //  "error",
+      //  { "allowNamedFunctions": true }
+      //],
+      "func-style": [
+        "error",
+        "declaration",
+        { "allowArrowFunctions": true }
+      ]
+
+    }
+}

.github/workflows/docker-image.yml

@@ -0,0 +1,38 @@
+name: Publish Docker image
+
+on:
+  push:
+    branches:
+    - master
+    - release/*
+  release:
+    types: [published]
+
+jobs:
+  push_to_registry:
+    name: Push Docker image to Docker Hub
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v4
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@f4ef78c080cd8ba55a85445d5b36e214a81df20a
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
+        with:
+          images: aliengen/timeoff-management-application
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@3b5e8027fcad23fda98b2e3ac259d8d67585f671
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.gitignore

@@ -5,3 +5,5 @@
 *.swm
 node_modules/
 *.sqlite
+*.DS_Store
+t/integration/test.csv

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "arrowParens": "avoid",
+  "trailingComma": "none"
+}

.vscode/settings.json

@@ -0,0 +1,25 @@
+{
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.organizeImports": "explicit",
+    "source.addMissingImports": "explicit",
+    "source.fixAll.eslint": "explicit"
+  },
+  "search.exclude": {
+    "**/node_modules": true,
+    "**/.vscode": true,
+    "**/build": true,
+    "**/dist": true
+  },
+  "git.autofetch": true,
+  "editor.trimAutoWhitespace": true,
+  "files.encoding": "utf8",
+  "files.trimFinalNewlines": false,
+  "files.trimTrailingWhitespace": true,
+  "css.validate": false,
+  "editor.quickSuggestions": {
+    "strings": true
+  },
+  "editor.detectIndentation": false,
+  "editor.tabSize": 2
+}

Dockerfile

@@ -5,38 +5,46 @@
 # =============
 # 1. Create an empty directory and copy this file into it.
 #
-# 2. Create image with: 
+# 2. Create image with:
 #	docker build --tag timeoff:latest .
 #
-# 3. Run with: 
+# 3. Run with:
 #	docker run -d -p 3000:3000 --name alpine_timeoff timeoff
 #
-# 4. Login to running container (to update config (vi config/app.json): 
-#	docker exec -ti --user root alpine_timeoff /bin/sh
 # --------------------------------------------------------------------
-FROM alpine:latest as dependencies
+FROM node:16-alpine
 
-RUN apk add --no-cache \
-    nodejs npm 
+RUN apk update
+#RUN apk upgrade
 
-COPY package.json  .
-RUN npm install 
+# Install dependencies
+RUN apk add \
+  git \
+  make \
+  python3 \
+  g++ \
+  gcc \
+  libc-dev \
+  clang
 
-FROM alpine:latest
+WORKDIR /app
 
 LABEL org.label-schema.schema-version="1.0"
 LABEL org.label-schema.docker.cmd="docker run -d -p 3000:3000 --name alpine_timeoff"
 
-RUN apk add --no-cache \
-    nodejs npm \
-    vim
+# Cache the docker layer with the node_modules
+COPY package.json /app/package.json
+COPY package-lock.json /app/package-lock.json
 
-RUN adduser --system app --home /app
-USER app
-WORKDIR /app
+RUN npm install -y
+
+# Copy the application into the container.
 COPY . /app
-COPY --from=dependencies node_modules ./node_modules
 
-CMD npm start
+# Add user so it doesn't run as root
+RUN adduser --system app --home /app
+USER app
 
 EXPOSE 3000
+
+CMD npm start

README.md

@@ -1,4 +1,3 @@
-
 # TimeOff.Management
 
 Web application for managing employee absences.
@@ -51,9 +50,9 @@ Ability to back up entire company leave data into CSV file. So it could be used
 
 The most used customer paths are mobile friendly:
 
-* employee is able to request new leave from mobile device
+- employee is able to request new leave from mobile device
 
-* supervisor is able to record decision from the mobile as well.
+- supervisor is able to record decision from the mobile as well.
 
 **Lots of other little things that would make life easier**
 
@@ -80,18 +79,158 @@ Create company account and use cloud based version.
 
 ### Self hosting
 
+```bash
+# Clone the repository
+git clone https://github.com/timeoff-management/application.git timeoff-management
+cd timeoff-management
+```
+
+Edit the configuration inside the `config` folder.
+
+#### Standalone
+
 Install TimeOff.Management application within your infrastructure:
 
-(make sure you have Node.js (>=4.0.0) and SQLite installed)
+(make sure you have Node.js (>=16.0.0) and SQLite installed)
 
 ```bash
-git clone https://github.com/timeoff-management/application.git timeoff-management
-cd timeoff-management
 npm install
 npm start
 ```
+
 Open http://localhost:3000/ in your browser.
 
+#### Using Docker
+
+##### Using an image from DockerHub [aliengen/timeoff-management-application](https://hub.docker.com/r/aliengen/timeoff-management-application)
+
+```bash
+# Pull the image
+docker pull aliengen/timeoff-management-application:master
+
+# Run the container using an `env` file to load the configuration
+docker run -d -p 3000:3000 --env-file ./env --name timeoff aliengen/timeoff-management-application:master
+
+# Or you can run the container using the `app.json` file to load the configuration
+docker run -d -p 3000:3000 -v ./config/app.json:/app/config/app.json --name timeoff aliengen/timeoff-management-application:master
+```
+
+##### Build the image manually
+
+You can build the image from the latest version of the repository.
+
+```bash
+# Build the docker image
+docker build --tag timeoff:latest .
+
+# Launch the docker image
+docker run -d -p 3000:3000 --name alpine_timeoff timeoff
+```
+
+##### Using Docker-compose
+
+```bash
+docker-compose up
+```
+
+## Configuration
+
+### Using environment variables
+
+| Variable                  | Description                                                  | Default value   |
+| ------------------------- | ------------------------------------------------------------ | --------------- |
+| BRANDING_URL | URL of the application | http://app.timeoff.management/ |
+| BRANDING_WEBSITE | URL of the company's website                                | http://timeoff.management/ |
+| PORT                      | Port of the application                                      | 3000            |
+| NODE_ENV                  | Environment of NodeJs                                        | development     |
+| CRYPTO_SECRET | Secret for password hashing |  |
+| DATABASE_URL              | Database URL format (`mysql://localhost:3306/database`)      |                 |
+| DB_HOST                   | Database hostname                                            |                 |
+| DB_DATABASE               | Database name                                                |                 |
+| DB_USERNAME               | Database username                                            |                 |
+| DB_PASSWORD               | Database password                                            |                 |
+| DB_DIALECT                | Database dialect (sqlite, mysql, postgres)                   | sqlite          |
+| DB_STORAGE                | Database storage file                                        | db.[ENV].sqlite |
+| DB_LOGGING                | Logging of queries                                           | false           |
+| DB_POOL_MAX               | Maximum number of connection in pool                         | 5               |
+| DB_POOL_MIN               | Minimum number of connection in pool                         | 0               |
+| DB_POOL_ACQUIRE           | The maximum time, in milliseconds, that pool will try to get connection before throwing error | 60000           |
+| DB_POOL_IDLE              | The maximum time, in milliseconds, that a connection can be idle before being released. | 10000           |
+| SMTP_HOST                 | Host of the smtp server                                      | localhost       |
+| SMTP_PORT                 | Port of the smtp server                                      | 25              |
+| SMTP_FROM                 | Sender email                                                 | [email protected]  |
+| SMTP_AUTH_USER            | Username for the smtp server                                 |                 |
+| SMTP_AUTH_PASS            | Password for the smtp server                                 |                 |
+| SMTP_REQUIRE_TLS          | Use STARTTLS                                                 | false           |
+| SESSIONS_SECRET | Secret for the sessions |  |
+| SESSIONS_STORE | Storage for the sessions (`sequelize`,`redis`) | sequelize |
+| SESSIONS_REDIS_HOST | Redis hostname | localhost |
+| SESSIONS_REDIS_PORT | Redis port | 6379 |
+| SLACK_TOKEN               | If set, the Slack token to send message                      |                 |
+| SLACK_BOT_NAME            | Name of the bot on Slack                                     |                 |
+| SLACK_ICON_URL            | Icon of the bot on Slack                                     |                 |
+| LOGIN_DEFAULT | Display the default login form | true |
+| LOGIN_GOOGLE | Enable the authentication with Google | false |
+| GOOGLE_ANALYTICS_TRACKER | Google Analytics tracker code                                |                 |
+| GOOGLE_AUTH_CLIENTID | Google Auth client ID | |
+| GOOGLE_AUTH_CLIENTSECRET | Google Auth client secret | |
+| GOOGLE_AUTH_DOMAINS  | Allowed domains | |
+| OPTIONS_REGISTRATION | Allow users to create a new company account on Timeoff | true            |
+
+### Using the JSON configuration files
+
+#### app.json
+
+```json
+{
+  "branding": {
+    "url": "http://app.timeoff.management",
+    "website": "http://timeoff.management"
+  },
+  "crypto_secret": "Secret used for password hashing",
+  "login": {
+    "default": true,
+    "google": false
+  },
+  "smtp": {
+    "host": "localhost",
+    "port": 25,
+    "from": "[email protected]",
+    "auth": {
+      "user": "user",
+      "pass": "pass"
+    }
+  },
+  "sessions": {
+    "secret": "Secret used for sessions",
+    "store": "sequelize",
+    "redis": {
+      "host": "localhost",
+      "port": 6379
+    }
+  },
+  "google": {
+    "analytics": {
+      "tracker": "Your GA tracker code"
+    },
+    "auth": {
+      "clientId": "123",
+      "clientSecret": "123",
+      "domains": ["myalloweddomain.com"]
+    }
+  },
+  "slack": {
+    "token": "Get your Web API token from you Slack admin page.",
+    "icon_url": "The image can be hosted anywhere, but I would recoment to upload an icon to your Slack and use it's url.",
+    "bot_name": "The display name for the messages being sent."
+  },
+  "options": {
+    "registration": true
+  },
+}
+```
+
+
 ## Run tests
 
 We have quite a wide test coverage, to make sure that the main user paths work as expected.