Version bump to v0.2.0

.gitignore

@@ -8,3 +8,5 @@ public/js/
 # Local data storage
 data/
 
+# Local config
+config/local.json

.woodpecker.yml

@@ -3,12 +3,21 @@ pipeline:
     image: node:18
     commands:
       - npm install
+      - npm run grunt
 
   lint:
     image: node:18
     commands:
       - npm run lint
 
+  linux_package:
+    group: packaging
+    image: node:18
+    commands:
+      - npm run grunt package
+    when:
+      event: tag
+
   gitea_release:
     image: plugins/gitea-release
     settings:
@@ -16,5 +25,38 @@ pipeline:
         from_secret: gitea_api_key
       base_url: https://git.metaunix.net
       title: "${CI_COMMIT_TAG}"
+      files:
+        - "dist/*.deb"
+    when:
+      event: tag
+
+  copy_deb_package:
+    image: appleboy/drone-scp
+    settings:
+      host: "repo.int.metaunix.net"
+      username:
+        from_secret: repo_admin
+      password:
+        from_secret: repo_password
+      port: 22
+      target: /srv/repo/apt/overseer/
+      source: dist/*.deb
+      strip_components: 1
+    when:
+      event: tag
+
+  update_repos:
+    image: appleboy/drone-ssh
+    settings:
+      host:
+        - repo.int.metaunix.net
+      username:
+        from_secret: repo_admin
+      password:
+        from_secret: repo_password
+      port: 22
+      command_timeout: 2m
+      script:
+        - "sudo ~/scripts/update_repo.sh"
     when:
       event: tag

Gruntfile.js

@@ -0,0 +1,133 @@
+module.exports = function(grunt) {
+
+  // Project configuration.
+  grunt.initConfig({
+    pkg: grunt.file.readJSON('package.json'),
+
+    sass: {
+      dist: {
+        options: {
+          style: 'compressed'
+        },
+        files: [{
+          expand: true,
+          cwd: 'assets/styles',
+          src: ['**/*.scss'],
+          dest: 'public/css',
+          ext: '.css'
+        }]
+      }
+    },
+
+    uglify: {
+      options: {
+        mangle: false
+      },
+      compile: {
+        files: {
+          'public/js/nechryael.min.js': ['assets/js/**/*.js']
+        }
+      }
+    },
+
+    watch: {
+      css: {
+        files: ['assets/styles/**/*.scss'],
+        tasks: ['sass'],
+        options: {
+          atBegin: true,
+          spawn: false
+        }
+      },
+      js: {
+        files: ['assets/js/**/*.js'],
+        tasks: ['uglify'],
+        options: {
+          atBegin: true,
+          spawn: false
+        }
+      }
+    },
+
+    deb_package: {
+      options: {
+        maintainer: 'Gregory Ballantine <gballantine@bitgoblin.tech>',
+        long_description: 'A simple web app to track inventory records.',
+        output: './dist/',
+      },
+      build: {
+        files: [
+          {
+            cwd: './',
+            src: 'index.js',
+            dest: '/opt/overseer'
+          },
+          {
+            cwd: './',
+            src: 'src/**/*',
+            dest: '/opt/overseer/'
+          },
+          {
+            cwd: './',
+            src: 'views/**/*',
+            dest: '/opt/overseer/'
+          },
+          {
+            cwd: './',
+            src: 'config/**/*',
+            dest: '/opt/overseer/'
+          },
+          {
+            cwd: './',
+            src: 'public/**/*',
+            dest: '/opt/overseer/'
+          },
+          {
+            cwd: './build/etc/',
+            src: 'default.json',
+            dest: '/etc/overseer/'
+          },
+          {
+            cwd: './build/etc/',
+            src: 'overseer.service',
+            dest: '/etc/systemd/system/'
+          },
+          {
+            cwd: './',
+            src: 'bin/**/*',
+            dest: '/opt/overseer/'
+          },
+          {
+            cwd: './',
+            src: 'node_modules/**/*',
+            dest: '/opt/overseer/'
+          },
+          {
+            cwd: './',
+            src: 'LICENSE',
+            dest: '/opt/overseer/',
+          },
+        ],
+        links: {
+          '/usr/bin/overseer': '/opt/overseer/bin/start.sh'
+        },
+        scripts: {
+          postinst: {
+            src: './build/scripts/postinst.sh'
+          },
+        },
+      },
+    }
+  });
+
+  // Load plugins.
+  grunt.loadNpmTasks('grunt-contrib-watch');
+  grunt.loadNpmTasks('grunt-contrib-sass');
+  grunt.loadNpmTasks('grunt-contrib-uglify');
+  grunt.loadNpmTasks('grunt-deb');
+
+  // CLI tasks.
+  grunt.registerTask('default', ['sass', 'uglify']);
+  grunt.registerTask('package', ['deb_package']);
+
+};

assets/js/nechryael.js

@@ -0,0 +1,3 @@
+$(document).ready(function() {
+  console.log('Document is ready!');
+});

bin/start.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+cd /opt/overseer/
+
+/usr/bin/env node index.js

build/etc/default.json

@@ -0,0 +1,10 @@
+{
+  "server": {
+    "address": "0.0.0.0",
+    "port": 3000
+  },
+  "database": {
+    "driver": "sqlite",
+    "connection_string": "/opt/overseer/data/overseer.db"
+  }
+}

build/etc/overseer.service

@@ -0,0 +1,12 @@
+[Unit]
+Description=Overseer inventory tracking app
+
+[Service]
+User=overseer
+Group=overseer
+Environment="NODE_CONFIG_DIR=/etc/overseer"
+ExecStart=/usr/bin/overseer
+SuccessExitStatus=143
+
+[Install]
+WantedBy=multi-user.target

build/scripts/postinst.sh

@@ -0,0 +1,41 @@
+#!/bin/sh
+
+GETENT_USER=$(getent passwd overseer)
+GETENT_GROUP=$(getent group overseer)
+
+# Create the overseer user if it doesn't already exist
+if [ "$GETENT_USER" = "" ]; then
+	echo "Creating the 'overseer' user."
+	useradd -r overseer
+else
+	echo "The 'overseer' user already exists, skipping creation."
+fi
+
+# Create the overseer group if it doesn't already exist
+if [ "$GETENT_GROUP" = "" ]; then
+	echo "Creating the 'overseer' group."
+	groupadd overseer
+	usermod -aG overseer overseer
+else
+	echo "The 'overseer' group already exists, skipping creation."
+fi
+
+# Change the directory ownership of /etc
+chown -R overseer:overseer /etc/overseer
+
+# Create the log directory under /var/log
+if [ ! -d /var/log/overseer ]; then
+	echo "Creating /var/log/overseer to store log files."
+	mkdir /var/log/overseer
+	chown overseer:overseer /var/log/overseer
+else
+	echo "/var/log/overseer already exists, skipping creation."
+fi
+
+# Make sure the app's source and configuration files are owned the new user and group
+chown -R overseer:overseer /opt/overseer
+chown -R overseer:overseer /etc/overseer
+
+#DEBHELPER#
+
+exit 0

config/default.json

@@ -1,6 +1,15 @@
 {
+  "server": {
+    "address": "0.0.0.0",
+    "port": 3000
+  },
   "database": {
     "driver": "sqlite",
     "connection_string": "data/overseer.db"
+  },
+  "redis": {
+    "host": "192.168.1.10",
+    "port": 6379,
+    "number": "0"
   }
 }

gulpfile.js

@@ -1,17 +0,0 @@
-const gulp = require('gulp');
-const { watch } = require('gulp');
-const sass = require('gulp-sass')(require('sass'));
-
-// compile 
-function styles(cb) {
-  return gulp.src('./assets/styles/**/*.scss')
-    .pipe(sass({outputStyle: 'compressed'}).on('error', sass.logError))
-    .pipe(gulp.dest('./public/css'));
-  cb();
-}
-
-// by default, watch files
-exports.default = function() {
-  // compile sass stylesheets
-  watch('assets/styles/**/*.scss', styles);
-};

index.js

@@ -1,8 +1,11 @@
 const express = require('express');
+const session = require('express-session');
+const RedisStore = require('connect-redis')(session);
+// const flash = require('express-flasher');
 
 // instantiate new express.js app
 const app = express();
-const port = 3000;
+const config = require('config');
 
 // initialize database connection
 (async () => {
@@ -12,6 +15,23 @@ const port = 3000;
   });
 })();
 
+// initialize Redis store for session data
+const redisClient = require('./src/redis');
+
+// initialize express.js session w/ Redis datastore
+app.use(session({
+  store: new RedisStore({
+    client: redisClient,
+  }), // use Redis datastore
+  resave: false, // don't save session if unmodified
+  saveUninitialized: false, // don't create session until something stored
+  secret: 'lord of the rings',
+}));
+
+// setup flash messaging
+// app.use(flash.flash());
+// app.use(flash.flashRead());
+
 // set up body POST parameters
 app.use(express.json());
 app.use(express.urlencoded({
@@ -37,6 +57,6 @@ app.get('/item/:id/edit', itemRoutes.getItemEdit);
 app.post('/item/:id/edit', itemRoutes.postItemEdit);
 
 // start app
-app.listen(port, () => {
+app.listen(config.get('server.port'), config.get('server.address'), () => {
-  console.log(`Example app listening on port ${port}`);
+  console.log(`Overseer is listening on port ${config.get('server.port')}.`);
 });

package.json

@@ -1,11 +1,11 @@
 {
   "name": "overseer",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Self-hosted inventory tracker",
   "main": "index.js",
   "scripts": {
     "start": "node index.js",
-    "gulp": "gulp",
+    "grunt": "grunt",
     "nodemon": "nodemon index.js",
     "lint": "eslint index.js src/**/*.js",
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -19,18 +19,35 @@
     "tracking"
   ],
   "author": "Gregory Ballanine <gballantine@bitgoblin.tech>",
+  "uploaders": [
+    {
+      "name": "Gregory Ballantine",
+      "email": "gballantine@bitgoblin.tech"
+    }
+  ],
   "license": "BSD-2-Clause",
   "devDependencies": {
     "eslint": "^8.26.0",
     "eslint-config-google": "^0.14.0",
-    "gulp": "^4.0.2",
+    "grunt": "^1.5.3",
-    "gulp-sass": "^5.1.0",
+    "grunt-cli": "^1.4.3",
+    "grunt-contrib-sass": "^2.0.0",
+    "grunt-contrib-uglify": "^5.2.2",
+    "grunt-contrib-watch": "^1.1.0",
+    "grunt-deb": "^0.2.5",
     "nodemon": "^2.0.20",
     "sass": "^1.55.0"
   },
   "dependencies": {
     "config": "^3.3.8",
+    "connect-redis": "^6.1.3",
     "express": "^4.18.2",
+    "express-session": "^1.17.3",
+    "mariadb": "^3.0.2",
+    "mysql2": "^2.3.3",
+    "pg": "^8.8.0",
+    "pg-hstore": "^2.3.4",
+    "redis": "^4.4.0",
     "sequelize": "^6.25.3",
     "sqlite3": "^5.1.2",
     "twig": "^1.15.4"

src/models/index.js

@@ -1,10 +1,7 @@
 const dbConfig = require('config').get('database');
 const Sequelize = require('sequelize');
 
-const sequelize = new Sequelize({
+const sequelize = initDatabase();
-  dialect: dbConfig.get('driver'),
-  storage: dbConfig.get('connection_string'),
-});
 
 const db = {};
 
@@ -14,3 +11,29 @@ db.sequelize = sequelize;
 db.items = require('./item.js')(sequelize, Sequelize);
 
 module.exports = db;
+
+/**
+ * Initializes a sequelize database connection.
+ *
+ * @return {object} - sequelize connection
+ */
+function initDatabase() {
+  let sequelize = null;
+
+  if (dbConfig.get('driver') == 'sqlite') {
+    sequelize = new Sequelize({
+      dialect: dbConfig.get('driver'),
+      storage: dbConfig.get('connection_string'),
+    });
+  } else {
+    const dbName = dbConfig.get('name');
+    const dbUsername = dbConfig.get('username');
+    const dbPassword = dbConfig.get('password');
+    sequelize = new Sequelize(dbName, dbUsername, dbPassword, {
+      dialect: dbConfig.get('driver'),
+      host: dbConfig.get('address'),
+    });
+  }
+
+  return sequelize;
+}

src/redis.js

@@ -0,0 +1,31 @@
+const redisConfig = require('config').get('redis');
+
+exports.default = function() {
+  let redisUrl = 'redis://';
+
+  // add the redis username if defined
+  if (typeof redisConfig.get('username') !== 'undefined') {
+    redisUrl += redisConfig.get('username');
+  }
+  // add the user password if defined
+  if (typeof redisConfig.get('password') !== 'undefined') {
+    redisUrl += ':' + redisConfig.get('password') + '@';
+  }
+  // add redis host URL
+  redisUrl += redisConfig.get('host');
+  // add redis host port
+  redisUrl += ':' + redisConfig.get('port');
+  // add redis database number if defined
+  if (typeof redisConfig.get('number') !== 'undefined') {
+    redisUrl += redisConfig.get('number');
+  }
+
+  const { createClient } = require("redis");
+  let redisClient = createClient({
+    url: redisUrl,
+    legacyMode: true,
+  });
+  redisClient.connect().catch(console.error);
+
+  return redisClient;
+};

src/routes/home.js

@@ -10,6 +10,8 @@ exports.getIndex = async function(req, res) {
     ],
   });
 
+  // req.flash('info', 'This is a test flash message.');
+
   res.render('index.twig', {
     inventory: items,
   });

views/layout.twig

@@ -9,7 +9,7 @@
   <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/skeleton/2.0.4/skeleton.min.css">
   <link rel="stylesheet" href="/css/gargoyle.css">
   <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
-  <script src="/js/drake.js"></script>
+  <script src="/js/nechryael.min.js"></script>
 </head>
 <body>
   <!-- global navigation -->
@@ -24,6 +24,12 @@
     </div>
   </nav>
 
+  {% if flash != null %}
+    <div class="flash-message {{ flash.type }}">
+      <p>{{ flash.msg }}</p>
+    </div>
+  {% endif %}
+
   <!-- main content -->
   <div id="main-content" class="container fluid">
     {% block content %}{% endblock %}