38 Commits

Author SHA1 Message Date
c86546af82 Version bump to v0.2.1
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
ci/woodpecker/tag/woodpecker Pipeline was successful
2022-11-06 11:41:14 -05:00
6c046dde81 Added license view and edit functions
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2022-11-06 11:40:45 -05:00
4167130f0c Started work on adding license tracking
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2022-11-06 01:37:56 -05:00
b98fbddd9e Version bump to v0.2.0
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
ci/woodpecker/tag/woodpecker Pipeline was successful
2022-11-05 16:16:11 -04:00
0818f57131 Added ability to use redis datastores for session data
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2022-11-05 16:14:37 -04:00
4a43aaabb6 Fixed linter errors
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
ci/woodpecker/tag/woodpecker Pipeline was successful
2022-11-04 21:30:31 -04:00
a297829ffc Version bump v0.1.5
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
2022-11-04 21:24:45 -04:00
4da2877a89 Added a way to configure using a remote database
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
2022-11-04 21:24:22 -04:00
2e309b29f1 Updated package-lock for v0.1.4
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2022-11-04 20:31:06 -04:00
0cea6eb4ca Version bump to v0.1.4
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
ci/woodpecker/tag/woodpecker Pipeline was successful
2022-11-04 18:25:29 -04:00
d1268fe708 Fixed system config in /etc
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
ci/woodpecker/tag/woodpecker Pipeline was successful
2022-11-04 18:23:29 -04:00
ff92316e1e Updated the systemd unit file to load the proper config file
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
ci/woodpecker/tag/woodpecker Pipeline was successful
2022-11-04 18:17:29 -04:00
629a7df3c4 Version bump to v0.1.3
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
ci/woodpecker/tag/woodpecker Pipeline was successful
2022-11-04 18:08:08 -04:00
30e23caf7f Added config options to define what host address and port to listen on
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2022-11-04 18:07:44 -04:00
9afe8c5391 Version bump v0.1.2
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
ci/woodpecker/tag/woodpecker Pipeline was successful
2022-11-04 17:59:25 -04:00
e958080702 Fixed some linter issues
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2022-11-04 17:54:43 -04:00
6455f3ff10 Changed to Grunt.js for task running
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
2022-11-04 17:53:42 -04:00
1536c0721d Added preliminary code for the express-flasher flash message integration - will uncomment code tomorrow when package can be published
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
2022-11-04 17:30:17 -04:00
64e71f7f98 Fixed strip_components parameter for copy_deb_package CI step
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
ci/woodpecker/tag/woodpecker Pipeline was successful
2022-11-04 09:33:48 -04:00
3b36d33d09 Fixed the path for uploading the .deb package to the repo
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
ci/woodpecker/tag/woodpecker Pipeline was successful
2022-11-04 09:26:48 -04:00
50d83ea4b9 Removed NPM production install
Some checks failed
ci/woodpecker/push/woodpecker Pipeline was successful
ci/woodpecker/tag/woodpecker Pipeline failed
2022-11-04 09:22:23 -04:00
b24dab7b84 Version bump to v0.1.1
Some checks failed
ci/woodpecker/push/woodpecker Pipeline was successful
ci/woodpecker/tag/woodpecker Pipeline failed
2022-11-04 09:17:45 -04:00
7685d2acd0 Updated CI config for Debian packaging
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2022-11-04 09:17:13 -04:00
21b48b1f3c Added debian packaging process
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2022-11-04 09:07:31 -04:00
5e895aa3ca Fixed code style errors
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
ci/woodpecker/tag/woodpecker Pipeline was successful
2022-11-03 22:28:01 -04:00
bfb8d751b8 Added Woodpecker CI config; added ESLint config to check for syntax and code style checks
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
2022-11-03 22:19:42 -04:00
cb5083d0d7 Added ability to edit item records 2022-11-03 22:08:45 -04:00
6c64e6c9a1 Added nodemon to automatically reload the app while developing it 2022-11-03 20:45:58 -04:00
01149d8da7 Added a record limiter to the main home view 2022-11-03 20:38:20 -04:00
5f00cf0edd Modified styles for the app to look better 2022-11-03 20:29:52 -04:00
6751d832fd Added some more fields to track for inventory; fixed routing issues with the /item/:id route 2022-11-03 12:26:45 -04:00
4a0241dd2b Added a page to view info about an item 2022-11-02 23:23:20 -04:00
1b46e7c3fb Added a table to display inventory on the home page; fixed the item add route 2022-11-02 14:29:46 -04:00
12770a995d Updated git ignore to exclude files under data/ 2022-11-02 14:03:52 -04:00
182356c685 Added the config module to handle app configuration loading; adding data/ folder for local sqlite storage 2022-11-02 14:03:20 -04:00
aa980948d8 Added a basic item add page/route 2022-11-02 13:45:40 -04:00
3c0ebc7001 Initial express.js project structure 2022-11-01 23:55:07 -04:00
53e0a557a3 Migrating to express.js project 2022-11-01 22:00:38 -04:00
43 changed files with 9154 additions and 6870 deletions

14
.eslintrc.json Normal file
View File

@ -0,0 +1,14 @@
{
"env": {
"es2021": true,
"node": true
},
"extends": "google",
"overrides": [
],
"parserOptions": {
"ecmaVersion": "latest"
},
"rules": {
}
}

15
.gitignore vendored
View File

@ -1,7 +1,12 @@
# ---> Composer
composer.phar
/vendor/
# ---> NPM modules (mainly for Gulp.js)
# NPM modules (mainly for Gulp.js)
node_modules/
# Compiled CSS and JS assets
public/css/
public/js/
# Local data storage
data/
# Local config
config/local.json

62
.woodpecker.yml Normal file
View File

@ -0,0 +1,62 @@
pipeline:
setup:
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:
api_key:
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

133
Gruntfile.js Normal file
View File

@ -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']);
};

View File

@ -1,4 +1,4 @@
Copyright (c) <year> <owner>
Copyright (c) 2022 Bit Goblin
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

3
assets/js/nechryael.js Normal file
View File

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

View File

@ -1,10 +1,42 @@
$nav-bar-height: 50px;
$primary-color: orangered;
$primary-color-highlight: darken($primary-color, 10%);
$box-shadow-1: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23);
$box-shadow-2: 0 10px 20px rgba(0,0,0,0.19), 0 6px 6px rgba(0,0,0,0.23);
$nav-bar-height: 60px;
body{
padding: $nav-bar-height 0 0;
background: lightgrey;
}
a{
color: $primary-color;
transition: all 230ms ease-in-out;
&:hover{
color: $primary-color-highlight;
}
}
.button.button-primary,
button.button-primary,
input[type="button"].button-primary,
input[type="reset"].button-primary,
input[type="submit"].button-primary{
background-color: $primary-color;
color: white;
transition: all 230ms ease-in-out;
&:hover{
background-color: $primary-color-highlight;
}
}
.container.fluid{
max-width: 100%;
}
#nav-bar{
position: fixed;
top: 0;
@ -12,7 +44,8 @@ body{
width: 100%;
height: $nav-bar-height;
background: #212121;
box-shadow: 0 2px 1px rgba(0, 0, 0, .25);
box-shadow: $box-shadow-1;
color: white;
.nav-bar-left{
float: left;
@ -26,12 +59,50 @@ body{
}
}
.site-logo,
.nav-link a{
color: teal;
transition: all 230ms ease-in-out;
padding: 10px 12px;
font-size: 2.5rem;
text-decoration: none;
}
&:hover{
color: green;
}
.site-logo{
padding-left: 35px;
font-weight: bold;
}
}
#main-content{
margin-top: 25px;
padding: 20px 32px;
background: white;
box-shadow: $box-shadow-2;
}
#record-actions{
p{
margin-bottom: 0;
font-size: 2rem;
}
}
#item-header,
#license-header{
margin-bottom: 25px;
h1,
p{
display: inline-block;
margin-bottom: 7px;
}
.item-added-date,
.item-updated-date,
.license-added-date,
.license-updated-date{
margin-bottom: 5px;
color: #666;
font-size: 1.6rem;
font-style: italic;
}
}

View File

@ -1,4 +0,0 @@
#!/bin/sh
# start a local instance of the app using PHP's built-in webserver
php -S localhost:8080 -t public/ public/index.php

5
bin/start.sh Executable file
View File

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

10
build/etc/default.json Normal file
View File

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

View File

@ -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

41
build/scripts/postinst.sh Executable file
View File

@ -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

View File

@ -1,24 +0,0 @@
{
"name": "bitgoblin/overseer",
"description": "Self-hosted inventory tracking web app",
"type": "project",
"license": "BSD-2-Clause",
"autoload": {
"psr-4": {
"BitGoblin\\Overseer\\": "src/"
}
},
"authors": [
{
"name": "Gregory Ballantine",
"email": "gballantine@bitgoblin.tech"
}
],
"minimum-stability": "stable",
"require": {
"slim/slim": "^4.10",
"slim/psr7": "^1.5",
"php-di/php-di": "^6.4",
"slim/twig-view": "^3.3"
}
}

1387
composer.lock generated

File diff suppressed because it is too large Load Diff

15
config/default.json Normal file
View File

@ -0,0 +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"
}
}

0
data/.gitkeep Normal file
View File

View File

@ -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);
};

68
index.js Normal file
View File

@ -0,0 +1,68 @@
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 config = require('config');
// initialize database connection
(async () => {
const db = require('./src/models');
await db.sequelize.sync({
alter: true,
});
})();
// 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({
extended: true,
}));
// load the template engine
app.set('view engine', 'twig');
// enable static file serving
app.use(express.static('public'));
// load route handlers
const homeRoutes = require('./src/routes/home');
const itemRoutes = require('./src/routes/item');
const licenseRoutes = require('./src/routes/license');
// register route handlers
app.get('/', homeRoutes.getIndex);
app.get('/item/add', itemRoutes.getAdd);
app.post('/item/add', itemRoutes.postAdd);
app.get('/item/:id', itemRoutes.getItem);
app.get('/item/:id/edit', itemRoutes.getItemEdit);
app.post('/item/:id/edit', itemRoutes.postItemEdit);
app.get('/license/add', licenseRoutes.getAdd);
app.post('/license/add', licenseRoutes.postAdd);
app.get('/license/:id', licenseRoutes.getLicense);
app.get('/license/:id/edit', licenseRoutes.getEdit);
app.post('/license/:id/edit', licenseRoutes.postEdit);
// start app
app.listen(config.get('server.port'), config.get('server.address'), () => {
console.log(`Overseer is listening on port ${config.get('server.port')}.`);
});

9
nodemon.json Normal file
View File

@ -0,0 +1,9 @@
{
"verbose": true,
"ext": "js,json,twig",
"ignore": [
"*.test.js",
"assets/",
"data/"
]
}

13246
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,10 +1,13 @@
{
"name": "overseer",
"version": "0.1.0",
"version": "0.2.1",
"description": "Self-hosted inventory tracker",
"main": "index.js",
"scripts": {
"gulp": "gulp",
"start": "node index.js",
"grunt": "grunt",
"nodemon": "nodemon index.js",
"lint": "eslint index.js src/**/*.js",
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
@ -16,10 +19,37 @@
"tracking"
],
"author": "Gregory Ballanine <gballantine@bitgoblin.tech>",
"uploaders": [
{
"name": "Gregory Ballantine",
"email": "gballantine@bitgoblin.tech"
}
],
"license": "BSD-2-Clause",
"devDependencies": {
"gulp": "^4.0.2",
"gulp-sass": "^5.1.0",
"eslint": "^8.26.0",
"eslint-config-google": "^0.14.0",
"grunt": "^1.5.3",
"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"
}
}

View File

@ -1,5 +0,0 @@
# rewrite rules
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^ index.php [QSA,L]

View File

@ -1 +0,0 @@
body{padding:50px 0 0;background:#d3d3d3}#nav-bar{position:fixed;top:0;left:0;width:100%;height:50px;background:#212121;box-shadow:0 2px 1px rgba(0,0,0,.25)}#nav-bar .nav-bar-left{float:left}#nav-bar ul{list-style:none}#nav-bar ul li{display:inline-block}#nav-bar .nav-link a{color:teal;transition:all 230ms ease-in-out}#nav-bar .nav-link a:hover{color:green}

View File

@ -1,24 +0,0 @@
<?php
// if we're looking for static files in dev, return false so they can be served.
if (PHP_SAPI == 'cli-server') {
$url = parse_url($_SERVER['REQUEST_URI']);
$file = __DIR__ . $url['path'];
// check the file types, only serve standard files
if (preg_match('/\.(?:png|js|jpg|jpeg|gif|css)$/', $file)) {
// does the file exist? If so, return it
if (is_file($file))
return false;
// file does not exist. return a 404
header($_SERVER['SERVER_PROTOCOL'].' 404 Not Found');
printf('"%s" does not exist', $_SERVER['REQUEST_URI']);
return false;
}
}
require_once __DIR__ . '/../src/app.php';
$app->run();

View File

@ -1,19 +0,0 @@
<?php
namespace BitGoblin\Overseer\Controllers;
use Psr\Container\ContainerInterface;
class Controller {
protected $container;
public function __construct(ContainerInterface $container) {
$this->container = $container;
}
public function get(string $name) {
return $this->container->get($name);
}
}

View File

@ -1,16 +0,0 @@
<?php
namespace BitGoblin\Overseer\Controllers;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
use Slim\Views\Twig;
class HomeController extends Controller {
public function getIndex(Request $request, Response $response): Response {
$view = Twig::fromRequest($request);
return $view->render($response, 'index.twig');
}
}

View File

@ -1,25 +0,0 @@
<?php
use DI\Container;
use Slim\Factory\AppFactory;
use Slim\Views\Twig;
use Slim\Views\TwigMiddleware;
require __DIR__ . '/../vendor/autoload.php';
// Create new container object and add our config object to it
$container = new Container();
// Set container to create App with on AppFactory
AppFactory::setContainer($container);
$app = AppFactory::create();
// create Twig instance
$twig = Twig::create('views', ['cache' => false]);
// add Twig-View Middleware
$app->add(TwigMiddleware::create($app, $twig));
// load routes
require_once __DIR__ . '/routes.php';
// app starts in public/index.php

40
src/models/index.js Normal file
View File

@ -0,0 +1,40 @@
const dbConfig = require('config').get('database');
const Sequelize = require('sequelize');
const sequelize = initDatabase();
const db = {};
db.Sequelize = Sequelize;
db.sequelize = sequelize;
db.items = require('./item.js')(sequelize, Sequelize);
db.licenses = require('./license.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;
}

35
src/models/item.js Normal file
View File

@ -0,0 +1,35 @@
module.exports = (sequelize, Sequelize) => {
const Item = sequelize.define('item', {
name: {
type: Sequelize.STRING,
},
manufacturer: {
type: Sequelize.STRING,
},
serialNumber: {
type: Sequelize.STRING,
},
skuNumber: {
type: Sequelize.STRING,
},
type: {
type: Sequelize.STRING,
},
purchasedFrom: {
type: Sequelize.STRING,
},
purchasedAt: {
type: Sequelize.DATE,
},
});
return Item;
};

27
src/models/license.js Normal file
View File

@ -0,0 +1,27 @@
module.exports = (sequelize, Sequelize) => {
const License = sequelize.define('license', {
name: {
type: Sequelize.STRING,
},
key: {
type: Sequelize.STRING,
},
manufacturer: {
type: Sequelize.STRING,
},
purchasedFrom: {
type: Sequelize.STRING,
},
purchasedAt: {
type: Sequelize.DATE,
},
});
return License;
};

31
src/redis.js Normal file
View File

@ -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;
};

View File

@ -1,7 +0,0 @@
<?php
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
// index GET route - this page should welcome the user and direct them to the available actions
$app->get('/', '\\BitGoblin\\Overseer\\Controllers\\HomeController:getIndex')->setName('index');

29
src/routes/home.js Normal file
View File

@ -0,0 +1,29 @@
const db = require('../models');
const Item = db.items;
const License = db.licenses;
// GET - /
exports.getIndex = async function(req, res) {
// fetch inventory items from database
const items = await Item.findAll({
limit: 10,
order: [
['updatedAt', 'DESC'],
],
});
// fetch licenses from database
const licenses = await License.findAll({
limit: 10,
order: [
['updatedAt', 'DESC'],
],
});
// req.flash('info', 'This is a test flash message.');
res.render('index.twig', {
inventory: items,
licenses: licenses,
});
};

78
src/routes/item.js Normal file
View File

@ -0,0 +1,78 @@
const db = require('../models');
const Item = db.items;
// GET - /item/add
exports.getAdd = async function(req, res) {
res.render('item/add.twig');
};
// POST - /item/add
exports.postAdd = async function(req, res) {
const item = await Item.create({
name: req.body.item_name,
serialNumber: req.body.item_serial,
skuNumber: req.body.item_sku,
purchasedFrom: req.body.item_purchase_from,
purchasedAt: req.body.item_purchase_date,
manufacturer: req.body.item_manufacturer,
type: req.body.item_type,
});
console.log(`Saved item ${item.name} to the database.`);
res.redirect('/');
};
// GET - /item/{id}
exports.getItem = async function(req, res) {
const item = await Item.findAll({
where: {
id: req.params.id,
},
});
res.render('item/view.twig', {
item: item[0],
});
};
// GET - /item/{id}/edit
exports.getItemEdit = async function(req, res) {
const item = await Item.findAll({
where: {
id: req.params.id,
},
});
res.render('item/edit.twig', {
item: item[0],
});
};
// POST - /item/{id}/edit
exports.postItemEdit = async function(req, res) {
// fetch item from DB
const itemSearch = await Item.findAll({
where: {
id: req.params.id,
},
});
// retrieve the item record from the array for ease of use
const item = itemSearch[0];
// update item attributes
item.name = req.body.item_name;
item.serialNumber = req.body.item_serial;
item.skuNumber = req.body.item_sku;
item.purchasedFrom = req.body.item_purchase_from;
item.purchasedAt = req.body.item_purchase_date;
item.manufacturer = req.body.item_manufacturer;
item.type = req.body.item_type;
// save attribute changes
await item.save();
// redirect user to item page
res.redirect('/item/' + item.id);
};

74
src/routes/license.js Normal file
View File

@ -0,0 +1,74 @@
const db = require('../models');
const License = db.licenses;
// GET - /license/add
exports.getAdd = async function(req, res) {
res.render('license/add.twig');
};
// POST - /license/add
exports.postAdd = async function(req, res) {
const license = await License.create({
name: req.body.license_name,
key: req.body.license_key,
manufacturer: req.body.license_manufacturer,
purchasedFrom: req.body.license_purchase_from,
purchasedAt: req.body.license_purchase_date,
});
console.log(`Saved license ${license.name} to the database.`);
res.redirect('/');
};
// GET - /license/{id}
exports.getLicense = async function(req, res) {
const license = await License.findAll({
where: {
id: req.params.id,
},
});
res.render('license/view.twig', {
license: license[0],
});
};
// GET - /license/{id}/edit
exports.getEdit = async function(req, res) {
const license = await License.findAll({
where: {
id: req.params.id,
},
});
res.render('license/edit.twig', {
license: license[0],
});
};
// POST - /license/{id}/edit
exports.postEdit = async function(req, res) {
// fetch license from DB
const licenseSearch = await License.findAll({
where: {
id: req.params.id,
},
});
// retrieve the license record from the array for ease of use
const license = licenseSearch[0];
// update license attributes
license.name = req.body.license_name;
license.key = req.body.license_key;
license.manufacturer = req.body.license_manufacturer;
license.purchasedFrom = req.body.license_purchase_from;
license.purchasedAt = req.body.license_purchase_date;
// save attribute changes
await license.save();
// redirect user to license page
res.redirect('/license/' + license.id);
};

View File

@ -1,5 +1,7 @@
{% extends 'layout.twig' %}
{% block title %}Home{% endblock %}
{% block content %}
<!-- page header -->
@ -9,4 +11,68 @@
</div>
</header>
<section id="record-actions" class="row">
<div class="columns six">
<a href="/item/add">
<p><i class="fa-solid fa-plus"></i> Add Item</p>
</a>
</div>
<div class="columns six">
<a href="/item/search">
<p><i class="fa-solid fa-search"></i> Search</p>
</a>
</div>
</section>
<hr>
<section class="row">
<div class="columns six">
<h3>Recently updated hardware:</h3>
<table class="u-full-width">
<thead>
<tr>
<th>Name</th>
<th>Manufacturer</th>
<th>Type</th>
<th>Updated at</th>
</tr>
</thead>
<tbody>
{% for item in inventory %}
<tr>
<td><a href="/item/{{ item.id }}">{{ item.name }}</a></td>
<td>{{ item.manufacturer }}</td>
<td>{{ item.type }}</td>
<td>{{ item.updatedAt | date("m/d/Y h:i:s A") }}</td>
</tr>
{% endfor %}
</tbody>
</table>
</div>
<div class="columns six">
<h3>Recently updated licenses:</h3>
<table class="u-full-width">
<thead>
<tr>
<th>Name</th>
<th>Manufacturer</th>
<th>Updated at</th>
</tr>
</thead>
<tbody>
{% for license in licenses %}
<tr>
<td><a href="/license/{{ license.id }}">{{ license.name }}</a></td>
<td>{{ license.manufacturer }}</td>
<td>{{ license.updatedAt | date("m/d/Y h:i:s A") }}</td>
</tr>
{% endfor %}
</tbody>
</table>
</div>
</section>
{% endblock %}

73
views/item/add.twig Normal file
View File

@ -0,0 +1,73 @@
{% extends 'layout.twig' %}
{% block title %}Add New Item{% endblock %}
{% block content %}
<!-- page header -->
<header class="row">
<div class="columns twelve">
<h1>Add new item</h1>
</div>
</header>
<section class="row">
<div class="columns twelve">
<form action="/item/add" method="POST">
<div class="row">
<div class="columns twelve">
<label for="item_name">Item name:</label>
<input class="u-full-width" type="text" placeholder="My new item" id="item_name" name="item_name" required>
</div>
</div>
<div class="row">
<div class="six columns">
<label for="item_serial">Serial number:</label>
<input class="u-full-width" type="text" placeholder="0123456789" id="item_serial" name="item_serial">
</div>
<div class="six columns">
<label for="item_sku">SKU number:</label>
<input class="u-full-width" type="text" placeholder="ABC12345678" id="item_sku" name="item_sku">
</div>
</div>
<div class="row">
<div class="six columns">
<label for="item_purchase_from">Purchased from:</label>
<input class="u-full-width" type="text" placeholder="Newegg" id="item_purchase_from" name="item_purchase_from">
</div>
<div class="six columns">
<label for="item_purchase_date">Purchased at:</label>
<input class="u-full-width" type="datetime-local" id="item_purchase_date" name="item_purchase_date">
</div>
</div>
<div class="row">
<div class="six columns">
<label for="item_manufacturer">Manufacturer:</label>
<input class="u-full-width" type="text" placeholder="Manufacturer" id="item_manufacturer" name="item_manufacturer">
</div>
<div class="six columns">
<label for="item_type">Item type</label>
<select class="u-full-width" id="item_type" name="item_type">
<option value="cpu">Processor</option>
<option value="motherboard">Motherboard</option>
<option value="memory">Memory (RAM)</option>
<option value="psu">Power Supply</option>
<option value="case">Case</option>
<option value="storage">Storage Device</option>
<option value="gpu">Graphics Card</option>
</select>
</div>
</div>
<input class="button-primary u-full-width" type="submit" value="Submit">
</form>
</div>
</section>
{% endblock %}

73
views/item/edit.twig Normal file
View File

@ -0,0 +1,73 @@
{% extends 'layout.twig' %}
{% block title %}Edit Item{% endblock %}
{% block content %}
<!-- page header -->
<header class="row">
<div class="columns twelve">
<h1>Editing "{{ item.name }}"</h1>
</div>
</header>
<section class="row">
<div class="columns twelve">
<form action="/item/{{ item.id }}/edit" method="POST">
<div class="row">
<div class="columns twelve">
<label for="item_name">Item name:</label>
<input class="u-full-width" type="text" placeholder="My new item" id="item_name" name="item_name" value="{{ item.name }}" required>
</div>
</div>
<div class="row">
<div class="six columns">
<label for="item_serial">Serial number:</label>
<input class="u-full-width" type="text" placeholder="0123456789" id="item_serial" name="item_serial" value="{{ item.serialNumber }}">
</div>
<div class="six columns">
<label for="item_sku">SKU number:</label>
<input class="u-full-width" type="text" placeholder="ABC12345678" id="item_sku" name="item_sku" value="{{ item.skuNumber }}">
</div>
</div>
<div class="row">
<div class="six columns">
<label for="item_purchase_from">Purchased from:</label>
<input class="u-full-width" type="text" placeholder="Newegg" id="item_purchase_from" name="item_purchase_from" value="{{ item.purchasedFrom }}">
</div>
<div class="six columns">
<label for="item_purchase_date">Purchased at:</label>
<input class="u-full-width" type="datetime-local" id="item_purchase_date" name="item_purchase_date" value="{{ item.purchasedAt }}">
</div>
</div>
<div class="row">
<div class="six columns">
<label for="item_manufacturer">Manufacturer:</label>
<input class="u-full-width" type="text" placeholder="Manufacturer" id="item_manufacturer" name="item_manufacturer" value="{{ item.manufacturer }}">
</div>
<div class="six columns">
<label for="item_type">Item type</label>
<select class="u-full-width" id="item_type" name="item_type" value="{{ item.type }}">
<option value="cpu">Processor</option>
<option value="motherboard">Motherboard</option>
<option value="memory">Memory (RAM)</option>
<option value="psu">Power Supply</option>
<option value="case">Case</option>
<option value="storage">Storage Device</option>
<option value="gpu">Graphics Card</option>
</select>
</div>
</div>
<input class="button-primary u-full-width" type="submit" value="Submit">
</form>
</div>
</section>
{% endblock %}

47
views/item/view.twig Normal file
View File

@ -0,0 +1,47 @@
{% extends 'layout.twig' %}
{% block title %}{{ item.name }}{% endblock %}
{% block content %}
<!-- page header -->
<header id="item-header" class="row">
<div class="columns twelve">
<span>
<h1>{{ item.name }}</h1>
<p><a href="/item/{{ item.id }}/edit"><i class="fa-solid fa-pen-to-square"></i> Edit</a></p>
</span>
<h4 class="item-added-date">Item added at: {{ item.createdAt }}</h4>
<h4 class="item-updated-date">Last updated at: {{ item.updatedAt }}</h4>
</div>
</header>
<!-- item information -->
<section class="row">
<table class="columns twelve">
<thead>
<tr>
<th>Product name</th>
<th>Serial number</th>
<th>SKU Number</th>
<th>Manufacturer</th>
<th>Type</th>
<th>Seller</th>
<th>Purchase date</th>
</tr>
</thead>
<tbody>
<tr>
<td>{{ item.name }}</td>
<td>{{ item.serialNumber ? item.serialNumber : 'N/a' }}</td>
<td>{{ item.skuNumber ? item.skuNumber : 'N/a' }}</td>
<td>{{ item.manufacturer ? item.manufacturer : 'N/a' }}</td>
<td>{{ item.type }}</td>
<td>{{ item.purchasedFrom ? item.purchasedFrom : 'N/a' }}</td>
<td>{{ item.purchasedAt | date("m/d/Y h:i:s A") }}</td>
</tr>
</tbody>
</table>
</section>
{% endblock %}

View File

@ -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 -->
@ -18,14 +18,21 @@
<ul>
<li class="site-logo">Overseer</li>
<li class="nav-link"><a href="/">Home</a></li>
<li class="nav-link"><a href="/search">Search</a></li>
<li class="nav-link"><a href="/add">Add Item</a></li>
<li class="nav-link"><a href="/item/search">Search</a></li>
<li class="nav-link"><a href="/item/add">Add Item</a></li>
<li class="nav-link"><a href="/license/add">Add License</a></li>
</ul>
</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">
<div id="main-content" class="container fluid">
{% block content %}{% endblock %}
</div>
</body>

53
views/license/add.twig Normal file
View File

@ -0,0 +1,53 @@
{% extends 'layout.twig' %}
{% block title %}Add New License{% endblock %}
{% block content %}
<!-- page header -->
<header class="row">
<div class="columns twelve">
<h1>Add new license</h1>
</div>
</header>
<section class="row">
<div class="columns twelve">
<form action="/license/add" method="POST">
<div class="row">
<div class="columns twelve">
<label for="license_name">License name:</label>
<input class="u-full-width" type="text" placeholder="My new license" id="license_name" name="license_name" required>
</div>
</div>
<div class="row">
<div class="six columns">
<label for="license_key">License Key:</label>
<input class="u-full-width" type="text" placeholder="ABCD-EFGH-1234-5678" id="license_key" name="license_key" required>
</div>
<div class="six columns">
<label for="license_manufacturer">Manufacturer:</label>
<input class="u-full-width" type="text" placeholder="Manufacturer" id="license_manufacturer" name="license_manufacturer">
</div>
</div>
<div class="row">
<div class="six columns">
<label for="license_purchase_from">Purchased from:</label>
<input class="u-full-width" type="text" placeholder="Newegg" id="license_purchase_from" name="license_purchase_from">
</div>
<div class="six columns">
<label for="license_purchase_date">Purchased at:</label>
<input class="u-full-width" type="datetime-local" id="license_purchase_date" name="license_purchase_date">
</div>
</div>
<input class="button-primary u-full-width" type="submit" value="Submit">
</form>
</div>
</section>
{% endblock %}

53
views/license/edit.twig Normal file
View File

@ -0,0 +1,53 @@
{% extends 'layout.twig' %}
{% block title %}Edit License{% endblock %}
{% block content %}
<!-- page header -->
<header class="row">
<div class="columns twelve">
<h1>Editing "{{ license.name }}"</h1>
</div>
</header>
<section class="row">
<div class="columns twelve">
<form action="/license/{{ license.id }}/edit" method="POST">
<div class="row">
<div class="columns twelve">
<label for="license_name">License name:</label>
<input class="u-full-width" type="text" placeholder="My new license" id="license_name" name="license_name" value="{{ license.name }}" required>
</div>
</div>
<div class="row">
<div class="six columns">
<label for="license_key">License key:</label>
<input class="u-full-width" type="text" placeholder="ABCD-EFGH-1234-5678" id="license_key" name="license_key" value="{{ license.key }}" required>
</div>
<div class="six columns">
<label for="license_manufacturer">Manufacturer:</label>
<input class="u-full-width" type="text" placeholder="Manufacturer" id="license_manufacturer" name="license_manufacturer" value="{{ license.manufacturer }}">
</div>
</div>
<div class="row">
<div class="six columns">
<label for="license_purchase_from">Purchased from:</label>
<input class="u-full-width" type="text" placeholder="Newegg" id="license_purchase_from" name="license_purchase_from" value="{{ license.purchasedFrom }}">
</div>
<div class="six columns">
<label for="license_purchase_date">Purchased at:</label>
<input class="u-full-width" type="datetime-local" id="license_purchase_date" name="license_purchase_date" value="{{ license.purchasedAt }}">
</div>
</div>
<input class="button-primary u-full-width" type="submit" value="Submit">
</form>
</div>
</section>
{% endblock %}

43
views/license/view.twig Normal file
View File

@ -0,0 +1,43 @@
{% extends 'layout.twig' %}
{% block title %}{{ license.name }}{% endblock %}
{% block content %}
<!-- page header -->
<header id="license-header" class="row">
<div class="columns twelve">
<span>
<h1>{{ license.name }}</h1>
<p><a href="/license/{{ license.id }}/edit"><i class="fa-solid fa-pen-to-square"></i> Edit</a></p>
</span>
<h4 class="license-added-date">license added at: {{ license.createdAt }}</h4>
<h4 class="license-updated-date">Last updated at: {{ license.updatedAt }}</h4>
</div>
</header>
<!-- license information -->
<section class="row">
<table class="columns twelve">
<thead>
<tr>
<th>Product name</th>
<th>License Key</th>
<th>Manufacturer</th>
<th>Seller</th>
<th>Purchase date</th>
</tr>
</thead>
<tbody>
<tr>
<td>{{ license.name }}</td>
<td>{{ license.key ? license.key : 'N/a' }}</td>
<td>{{ license.manufacturer ? license.manufacturer : 'N/a' }}</td>
<td>{{ license.purchasedFrom ? license.purchasedFrom : 'N/a' }}</td>
<td>{{ license.purchasedAt | date("m/d/Y h:i:s A") }}</td>
</tr>
</tbody>
</table>
</section>
{% endblock %}