diff --git a/docker/entrypoint.sh b/docker/entrypoint.sh index 8ca06b1..aeed216 100644 --- a/docker/entrypoint.sh +++ b/docker/entrypoint.sh @@ -1,7 +1,6 @@ #!/usr/bin/env bash set -Eeuo pipefail - echo >&2 "-------------------------------------------------------------" echo >&2 ""; echo >&2 " ██ ██ ██ ███ ███ ██████" diff --git a/jumpapp/assets/js/src/classes/Clock.js b/jumpapp/assets/js/src/classes/Clock.js index 22d5e5a..e7dcc44 100644 --- a/jumpapp/assets/js/src/classes/Clock.js +++ b/jumpapp/assets/js/src/classes/Clock.js @@ -1,12 +1,20 @@ +/** + * ██ ██ ██ ███ ███ ██████ + * ██ ██ ██ ████ ████ ██ ██ + * ██ ██ ██ ██ ████ ██ ██████ + * ██ ██ ██ ██ ██ ██ ██ ██ + * █████ ██████ ██ ██ ██ + * + * @author Dale Davies + * @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 - * @license MIT */ - export default class Clock { /** * Calculate the time shifted from UTC. diff --git a/jumpapp/assets/js/src/classes/Greeting.js b/jumpapp/assets/js/src/classes/Greeting.js index af23010..53341aa 100644 --- a/jumpapp/assets/js/src/classes/Greeting.js +++ b/jumpapp/assets/js/src/classes/Greeting.js @@ -1,3 +1,15 @@ +/** + * ██ ██ ██ ███ ███ ██████ + * ██ ██ ██ ████ ████ ██ ██ + * ██ ██ ██ ██ ████ ██ ██████ + * ██ ██ ██ ██ ██ ██ ██ ██ + * █████ ██████ ██ ██ ██ + * + * @author Dale Davies + * @copyright Copyright (c) 2022, Dale Davies + * @license MIT + */ + import Clock from "./Clock"; export default class Greeting { diff --git a/jumpapp/assets/js/src/classes/Main.js b/jumpapp/assets/js/src/classes/Main.js index 72c3d6a..442c76e 100644 --- a/jumpapp/assets/js/src/classes/Main.js +++ b/jumpapp/assets/js/src/classes/Main.js @@ -1,3 +1,15 @@ +/** + * ██ ██ ██ ███ ███ ██████ + * ██ ██ ██ ████ ████ ██ ██ + * ██ ██ ██ ██ ████ ██ ██████ + * ██ ██ ██ ██ ██ ██ ██ ██ + * █████ ██████ ██ ██ ██ + * + * @author Dale Davies + * @copyright Copyright (c) 2022, Dale Davies + * @license MIT + */ + import Clock from './Clock'; import EventEmitter from 'eventemitter3'; import Fuse from 'fuse.js'; diff --git a/jumpapp/assets/js/src/classes/SearchSuggestions.js b/jumpapp/assets/js/src/classes/SearchSuggestions.js index 86825ea..f3144db 100644 --- a/jumpapp/assets/js/src/classes/SearchSuggestions.js +++ b/jumpapp/assets/js/src/classes/SearchSuggestions.js @@ -1,10 +1,18 @@ /** - * Generate search suggestions. + * ██ ██ ██ ███ ███ ██████ + * ██ ██ ██ ████ ████ ██ ██ + * ██ ██ ██ ██ ████ ██ ██████ + * ██ ██ ██ ██ ██ ██ ██ ██ + * █████ ██████ ██ ██ ██ * * @author Dale Davies + * @copyright Copyright (c) 2022, Dale Davies * @license MIT */ +/** + * Generate search suggestions. + */ export default class SearchSuggestions { constructor(searchengines, inputelm, containerelm, eventemitter) { diff --git a/jumpapp/assets/js/src/classes/Weather.js b/jumpapp/assets/js/src/classes/Weather.js index db456a0..4464ddf 100644 --- a/jumpapp/assets/js/src/classes/Weather.js +++ b/jumpapp/assets/js/src/classes/Weather.js @@ -1,3 +1,15 @@ +/** + * ██ ██ ██ ███ ███ ██████ + * ██ ██ ██ ████ ████ ██ ██ + * ██ ██ ██ ██ ████ ██ ██████ + * ██ ██ ██ ██ ██ ██ ██ ██ + * █████ ██████ ██ ██ ██ + * + * @author Dale Davies + * @copyright Copyright (c) 2022, Dale Davies + * @license MIT + */ + export default class Weather { /** diff --git a/jumpapp/assets/js/src/index.js b/jumpapp/assets/js/src/index.js index a905c4d..9d8c906 100644 --- a/jumpapp/assets/js/src/index.js +++ b/jumpapp/assets/js/src/index.js @@ -1,10 +1,19 @@ /** - * Do some fancy UI stuff in a rather unfancy way. + * ██ ██ ██ ███ ███ ██████ + * ██ ██ ██ ████ ████ ██ ██ + * ██ ██ ██ ██ ████ ██ ██████ + * ██ ██ ██ ██ ██ ██ ██ ██ + * █████ ██████ ██ ██ ██ * * @author Dale Davies + * @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'; diff --git a/jumpapp/background-css.php b/jumpapp/background-css.php index 53045d6..b7942f8 100644 --- a/jumpapp/background-css.php +++ b/jumpapp/background-css.php @@ -1,11 +1,20 @@ + * @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'; diff --git a/jumpapp/classes/API/AbstractAPI.php b/jumpapp/classes/API/AbstractAPI.php index a5b57b1..c30f641 100644 --- a/jumpapp/classes/API/AbstractAPI.php +++ b/jumpapp/classes/API/AbstractAPI.php @@ -1,4 +1,15 @@ + * @copyright Copyright (c) 2022, Dale Davies + * @license MIT + */ namespace Jump\API; diff --git a/jumpapp/classes/API/Icon.php b/jumpapp/classes/API/Icon.php index 9fc2ff3..ad94ff3 100644 --- a/jumpapp/classes/API/Icon.php +++ b/jumpapp/classes/API/Icon.php @@ -1,4 +1,15 @@ + * @copyright Copyright (c) 2022, Dale Davies + * @license MIT + */ namespace Jump\API; diff --git a/jumpapp/classes/API/Unsplash.php b/jumpapp/classes/API/Unsplash.php index 7eca71d..718128a 100644 --- a/jumpapp/classes/API/Unsplash.php +++ b/jumpapp/classes/API/Unsplash.php @@ -1,4 +1,15 @@ + * @copyright Copyright (c) 2022, Dale Davies + * @license MIT + */ namespace Jump\API; diff --git a/jumpapp/classes/API/Weather.php b/jumpapp/classes/API/Weather.php index 4e3dbfc..315b03b 100644 --- a/jumpapp/classes/API/Weather.php +++ b/jumpapp/classes/API/Weather.php @@ -1,4 +1,15 @@ + * @copyright Copyright (c) 2022, Dale Davies + * @license MIT + */ namespace Jump\API; diff --git a/jumpapp/classes/Background.php b/jumpapp/classes/Background.php index 277d33d..4d64df3 100644 --- a/jumpapp/classes/Background.php +++ b/jumpapp/classes/Background.php @@ -1,4 +1,15 @@ + * @copyright Copyright (c) 2022, Dale Davies + * @license MIT + */ namespace Jump; diff --git a/jumpapp/classes/Cache.php b/jumpapp/classes/Cache.php index 9ea3b2e..1cc8431 100644 --- a/jumpapp/classes/Cache.php +++ b/jumpapp/classes/Cache.php @@ -1,4 +1,15 @@ + * @copyright Copyright (c) 2022, Dale Davies + * @license MIT + */ namespace Jump; diff --git a/jumpapp/classes/Config.php b/jumpapp/classes/Config.php index 387b83a..9233bb6 100644 --- a/jumpapp/classes/Config.php +++ b/jumpapp/classes/Config.php @@ -1,4 +1,15 @@ + * @copyright Copyright (c) 2022, Dale Davies + * @license MIT + */ namespace Jump; diff --git a/jumpapp/classes/Exceptions/TagNotFoundException.php b/jumpapp/classes/Exceptions/TagNotFoundException.php index 44795c6..0a844ee 100644 --- a/jumpapp/classes/Exceptions/TagNotFoundException.php +++ b/jumpapp/classes/Exceptions/TagNotFoundException.php @@ -1,4 +1,15 @@ + * @copyright Copyright (c) 2022, Dale Davies + * @license MIT + */ namespace Jump\Exceptions; diff --git a/jumpapp/classes/Main.php b/jumpapp/classes/Main.php index fab573e..c467a5f 100644 --- a/jumpapp/classes/Main.php +++ b/jumpapp/classes/Main.php @@ -1,9 +1,14 @@ + * @copyright Copyright (c) 2022, Dale Davies + * @license MIT */ namespace Jump; diff --git a/jumpapp/classes/Pages/AbstractPage.php b/jumpapp/classes/Pages/AbstractPage.php index 7bf9bcf..4747856 100644 --- a/jumpapp/classes/Pages/AbstractPage.php +++ b/jumpapp/classes/Pages/AbstractPage.php @@ -1,4 +1,15 @@ + * @copyright Copyright (c) 2022, Dale Davies + * @license MIT + */ namespace Jump\Pages; diff --git a/jumpapp/classes/Pages/ErrorPage.php b/jumpapp/classes/Pages/ErrorPage.php index 410438d..86f35af 100644 --- a/jumpapp/classes/Pages/ErrorPage.php +++ b/jumpapp/classes/Pages/ErrorPage.php @@ -1,4 +1,15 @@ + * @copyright Copyright (c) 2022, Dale Davies + * @license MIT + */ namespace Jump\Pages; diff --git a/jumpapp/classes/Pages/HomePage.php b/jumpapp/classes/Pages/HomePage.php index 13583d3..0dbb9d0 100644 --- a/jumpapp/classes/Pages/HomePage.php +++ b/jumpapp/classes/Pages/HomePage.php @@ -1,4 +1,15 @@ + * @copyright Copyright (c) 2022, Dale Davies + * @license MIT + */ namespace Jump\Pages; diff --git a/jumpapp/classes/Pages/TagPage.php b/jumpapp/classes/Pages/TagPage.php index a9a6314..7ef1598 100644 --- a/jumpapp/classes/Pages/TagPage.php +++ b/jumpapp/classes/Pages/TagPage.php @@ -1,4 +1,15 @@ + * @copyright Copyright (c) 2022, Dale Davies + * @license MIT + */ namespace Jump\Pages; diff --git a/jumpapp/classes/SearchEngines.php b/jumpapp/classes/SearchEngines.php index 4ab94ff..6bf05b1 100644 --- a/jumpapp/classes/SearchEngines.php +++ b/jumpapp/classes/SearchEngines.php @@ -1,4 +1,15 @@ + * @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 - * @license MIT */ class SearchEngines { private array $default; diff --git a/jumpapp/classes/Site.php b/jumpapp/classes/Site.php index 289bb99..bdf069e 100644 --- a/jumpapp/classes/Site.php +++ b/jumpapp/classes/Site.php @@ -1,4 +1,15 @@ + * @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 - * @license MIT */ class Site { diff --git a/jumpapp/classes/Sites.php b/jumpapp/classes/Sites.php index 9434ec0..3408373 100644 --- a/jumpapp/classes/Sites.php +++ b/jumpapp/classes/Sites.php @@ -1,4 +1,15 @@ + * @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 - * @license MIT */ class Sites { diff --git a/jumpapp/classes/Unsplash.php b/jumpapp/classes/Unsplash.php index 1725802..ba9a123 100644 --- a/jumpapp/classes/Unsplash.php +++ b/jumpapp/classes/Unsplash.php @@ -1,4 +1,15 @@ + * @copyright Copyright (c) 2022, Dale Davies + * @license MIT + */ namespace Jump; diff --git a/jumpapp/cli/cacheunsplash.php b/jumpapp/cli/cacheunsplash.php index e94736c..1eb5a6f 100644 --- a/jumpapp/cli/cacheunsplash.php +++ b/jumpapp/cli/cacheunsplash.php @@ -1,11 +1,20 @@ + * @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'; diff --git a/jumpapp/config.php b/jumpapp/config.php index 51bc445..7c5a38a 100644 --- a/jumpapp/config.php +++ b/jumpapp/config.php @@ -1,11 +1,19 @@ + * @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', diff --git a/jumpapp/index.php b/jumpapp/index.php index 73c38c0..884f9c2 100644 --- a/jumpapp/index.php +++ b/jumpapp/index.php @@ -1,11 +1,20 @@ + * @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'; diff --git a/webpack.config.js b/webpack.config.js index 02dd01b..cf7e023 100644 --- a/webpack.config.js +++ b/webpack.config.js @@ -1,3 +1,15 @@ +/** + * ██ ██ ██ ███ ███ ██████ + * ██ ██ ██ ████ ████ ██ ██ + * ██ ██ ██ ██ ████ ██ ██████ + * ██ ██ ██ ██ ██ ██ ██ ██ + * █████ ██████ ██ ██ ██ + * + * @author Dale Davies + * @copyright Copyright (c) 2022, Dale Davies + * @license MIT + */ + const path = require('path'); const Terser = require('terser-webpack-plugin'); const HtmlWebpackPlugin = require('html-webpack-plugin');