Dockery/Jump
1
0
Fork 0
mirror of https://github.com/daledavies/jump.git synced 2026-01-06 23:42:07 +01:00
Code Issues Packages Projects Releases Activity

Add file comments with Jump banner

Browse Source
This commit is contained in:
Dale Davies
2022-07-19 16:38:55 +01:00
parent 93bab6bdab
commit cc00b97ca0
29 changed files with 302 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docker/entrypoint.sh
View File

@@ -1,7 +1,6 @@
#!/usr/bin/env bash
set -Eeuo pipefail
echo >&2 "-------------------------------------------------------------"
echo >&2 "";
echo >&2 " ██ ██ ██ ███ ███ ██████"

16
jumpapp/assets/js/src/classes/Clock.js
View File

@@ -1,12 +1,20 @@
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
/**
* Calculate the time, local to the requested location from
* the OpenWeather API, by passing in the number of seconds
* that location has shifted from UTC based on the timezones.
*
* @author Dale Davies <dale@daledavies.co.uk>
* @license MIT
*/
export default class Clock {
/**
* Calculate the time shifted from UTC.

12
jumpapp/assets/js/src/classes/Greeting.js
View File

@@ -1,3 +1,15 @@
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
import Clock from "./Clock";
export default class Greeting {

12
jumpapp/assets/js/src/classes/Main.js
View File

@@ -1,3 +1,15 @@
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
import Clock from './Clock';
import EventEmitter from 'eventemitter3';
import Fuse from 'fuse.js';

10
jumpapp/assets/js/src/classes/SearchSuggestions.js
View File

@@ -1,10 +1,18 @@
/**
* Generate search suggestions.
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
/**
* Generate search suggestions.
*/
export default class SearchSuggestions {
constructor(searchengines, inputelm, containerelm, eventemitter) {

12
jumpapp/assets/js/src/classes/Weather.js
View File

@@ -1,3 +1,15 @@
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
export default class Weather {
/**

11
jumpapp/assets/js/src/index.js
View File

@@ -1,10 +1,19 @@
/**
* Do some fancy UI stuff in a rather unfancy way.
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
/**
* Do some fancy UI stuff in a rather unfancy way.
*/
import Main from './classes/Main';
import version from '../../../.jump-version';

11
jumpapp/background-css.php
View File

@@ -1,11 +1,20 @@
<?php
/**
* Generate dynamic CSS for randomising the background image.
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
/**
* Generate dynamic CSS for randomising the background image.
*/
// Provided by composer for psr-4 style autoloading.
require __DIR__ .'/vendor/autoload.php';

11
jumpapp/classes/API/AbstractAPI.php
View File

@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
namespace Jump\API;

11
jumpapp/classes/API/Icon.php
View File

@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
namespace Jump\API;

11
jumpapp/classes/API/Unsplash.php
View File

@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
namespace Jump\API;

11
jumpapp/classes/API/Weather.php
View File

@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
namespace Jump\API;

11
jumpapp/classes/Background.php
View File

@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
namespace Jump;

11
jumpapp/classes/Cache.php
View File

@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
namespace Jump;

11
jumpapp/classes/Config.php
View File

@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
namespace Jump;

11
jumpapp/classes/Exceptions/TagNotFoundException.php
View File

@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
namespace Jump\Exceptions;

11
jumpapp/classes/Main.php
View File

@@ -1,9 +1,14 @@
<?php
/**
* TO DO:
* - use CSRF token in weatherdata and icon api
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
namespace Jump;

11
jumpapp/classes/Pages/AbstractPage.php
View File

@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
namespace Jump\Pages;

11
jumpapp/classes/Pages/ErrorPage.php
View File

@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
namespace Jump\Pages;

11
jumpapp/classes/Pages/HomePage.php
View File

@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
namespace Jump\Pages;

11
jumpapp/classes/Pages/TagPage.php
View File

@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
namespace Jump\Pages;

14
jumpapp/classes/SearchEngines.php
View File

@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
namespace Jump;
@@ -6,9 +17,6 @@ use \Exception;
/**
* Loads and validates the search engines defined in searchengines.json.
*
* @author Dale Davies <dale@daledavies.co.uk>
* @license MIT
*/
class SearchEngines {
private array $default;

14
jumpapp/classes/Site.php
View File

@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
namespace Jump;
@@ -7,9 +18,6 @@ use stdClass;
/**
* Parse the data required to represent a site and provide method for generating
* and/or retrieving the site's icon.
*
* @author Dale Davies <dale@daledavies.co.uk>
* @license MIT
*/
class Site {

16
jumpapp/classes/Sites.php
View File

@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
namespace Jump;
@@ -8,11 +19,6 @@ use \Jump\Exceptions\TagNotFoundException;
/**
* Loads, validates and caches the site data defined in sites.json
* into an array of Site objects.
*
* TO DO: Implement search() method.
*
* @author Dale Davies <dale@daledavies.co.uk>
* @license MIT
*/
class Sites {

11
jumpapp/classes/Unsplash.php
View File

@@ -1,4 +1,15 @@
<?php
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
namespace Jump;

11
jumpapp/cli/cacheunsplash.php
View File

@@ -1,11 +1,20 @@
<?php
/**
* Proxy requests to Unsplash API and cache response.
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
/**
* Proxy requests to Unsplash API and cache response.
*/
// Provided by composer for psr-4 style autoloading.
require __DIR__ .'/../vendor/autoload.php';

10
jumpapp/config.php
View File

@@ -1,11 +1,19 @@
<?php
/**
* Edit the configuration below to suit your requirements.
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
/**
* Edit the configuration below to suit your requirements.
*/
return [
// The site name is displayed in the browser tab.
'sitename' => getenv('SITENAME') ?: 'Jump',

11
jumpapp/index.php
View File

@@ -1,11 +1,20 @@
<?php
/**
* Initialise the application, generate and output page content.
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
/**
* Initialise the application, generate and output page content.
*/
// Provided by composer for psr-4 style autoloading.
require __DIR__ .'/vendor/autoload.php';

12
webpack.config.js
View File

@@ -1,3 +1,15 @@
/**
* ██ ██ ██ ███ ███ ██████
* ██ ██ ██ ████ ████ ██ ██
* ██ ██ ██ ██ ████ ██ ██████
* ██ ██ ██ ██ ██ ██ ██ ██
* █████ ██████ ██ ██ ██
*
* @author Dale Davies <dale@daledavies.co.uk>
* @copyright Copyright (c) 2022, Dale Davies
* @license MIT
*/
const path = require('path');
const Terser = require('terser-webpack-plugin');
const HtmlWebpackPlugin = require('html-webpack-plugin');