├── server ├── cache │ └── .gitkeep ├── lib │ ├── index.js │ ├── util.js │ ├── logger.js │ └── request.js ├── index.html ├── index.js └── api │ └── index.js ├── .dockerignore ├── assets ├── robots.txt ├── icon.png ├── favicon.ico ├── courier-anpost.png ├── favicon-32x32.png ├── apple-touch-icon.png └── manifest.json ├── .env.sample ├── .npmrc ├── client ├── index.js ├── lib │ ├── index.js │ ├── event.js │ ├── request.js │ ├── utils.js │ ├── pubsub.js │ └── store.js ├── app │ ├── index.svelte │ └── index.styl ├── main │ ├── index.styl │ └── index.svelte ├── tracking │ ├── tracking-number.svelte │ ├── index.svelte │ └── index.styl ├── header │ ├── index.styl │ └── index.svelte ├── toaster │ ├── index.styl │ └── index.svelte └── ui-style │ ├── button.styl │ ├── form.styl │ └── lib.styl ├── .gitignore ├── docker-compose.yml ├── .editorconfig ├── Dockerfile ├── .eslintrc ├── README.md ├── package.json ├── gulpfile.js ├── release.js └── LICENSE /server/cache/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.dockerignore: -------------------------------------------------------------------------------- 1 | Dockerfile 2 | node_modules 3 | -------------------------------------------------------------------------------- /assets/robots.txt: -------------------------------------------------------------------------------- 1 | User-agent: * 2 | Disallow: / 3 | -------------------------------------------------------------------------------- /.env.sample: -------------------------------------------------------------------------------- 1 | TOKEN=82304982304.asfddsf 2 | NODE_ENV=dev 3 | -------------------------------------------------------------------------------- /assets/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tborychowski/courier/HEAD/assets/icon.png -------------------------------------------------------------------------------- /assets/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tborychowski/courier/HEAD/assets/favicon.ico -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | registry=https://registry.npmjs.org/ 2 | @types:registry=https://registry.npmjs.org/ 3 | -------------------------------------------------------------------------------- /assets/courier-anpost.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tborychowski/courier/HEAD/assets/courier-anpost.png -------------------------------------------------------------------------------- /assets/favicon-32x32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tborychowski/courier/HEAD/assets/favicon-32x32.png -------------------------------------------------------------------------------- /client/index.js: -------------------------------------------------------------------------------- 1 | import App from './app'; 2 | 3 | new App({ target: document.querySelector('#app') }); 4 | -------------------------------------------------------------------------------- /assets/apple-touch-icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tborychowski/courier/HEAD/assets/apple-touch-icon.png -------------------------------------------------------------------------------- /client/lib/index.js: -------------------------------------------------------------------------------- 1 | export * from './request'; 2 | export * from './utils'; 3 | export * from './event'; 4 | export * from './store'; 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | _stuff/ 3 | public/ 4 | logs/ 5 | cache/*.json 6 | 7 | 8 | .DS_Store 9 | *.log 10 | *.db 11 | .env 12 | -------------------------------------------------------------------------------- /client/app/index.svelte: -------------------------------------------------------------------------------- 1 |
2 |
3 | 4 | 5 | 11 | -------------------------------------------------------------------------------- /server/lib/index.js: -------------------------------------------------------------------------------- 1 | const logger = require('./logger'); 2 | const util = require('./util'); 3 | const request = require('./request'); 4 | 5 | module.exports = { 6 | ...util, 7 | ...request, 8 | logger 9 | }; 10 | -------------------------------------------------------------------------------- /client/main/index.styl: -------------------------------------------------------------------------------- 1 | @import "lib" 2 | 3 | .main 4 | background dark-color-bg1 5 | padding 0 6 | height 100% 7 | min-height 100% 8 | 9 | .placeholder-text 10 | height 100% 11 | display flex 12 | align-items center 13 | justify-content center 14 | -------------------------------------------------------------------------------- /client/lib/event.js: -------------------------------------------------------------------------------- 1 | import {on, off, fire} from './pubsub'; 2 | export const EVENT = { 3 | on, 4 | off, 5 | fire, 6 | 7 | tracking: { 8 | added: 'tracking-added', 9 | deleted: 'tracking-deleted' 10 | }, 11 | document: { 12 | clicked: 'document-clicked' 13 | }, 14 | 15 | 16 | }; 17 | -------------------------------------------------------------------------------- /server/lib/util.js: -------------------------------------------------------------------------------- 1 | const env = process.env.NODE_ENV; 2 | 3 | const isTest = env === 'test'; 4 | const isDev = (env === 'development' || env === 'dev'); 5 | const isProd = (env === 'production' || env === 'prod'); 6 | 7 | 8 | module.exports = { 9 | isDev, 10 | isTest, 11 | isProd, 12 | }; 13 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | --- 2 | version: '3.7' 3 | services: 4 | courier: 5 | container_name: courier 6 | image: tborychowski/courier 7 | restart: unless-stopped 8 | ports: 9 | - "3000:3000" 10 | environment: 11 | - NODE_ENV=production 12 | - TOKEN=093284923048sdkfjsdlfkj 13 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | 4 | [*] 5 | # Change these settings to your own preference 6 | indent_style = tab 7 | indent_size = 4 8 | 9 | # We recommend you to keep these unchanged 10 | end_of_line = lf 11 | charset = utf-8 12 | trim_trailing_whitespace = true 13 | insert_final_newline = true 14 | 15 | [*.md] 16 | trim_trailing_whitespace = false 17 | 18 | [package.json] 19 | indent_style = space 20 | indent_size = 2 -------------------------------------------------------------------------------- /client/app/index.styl: -------------------------------------------------------------------------------- 1 | @import "lib" 2 | 3 | html 4 | body 5 | margin 0 6 | padding 0 7 | height 100% 8 | width 100% 9 | overflow hidden 10 | 11 | body 12 | font normal 14px sans-serif 13 | box-sizing border-box 14 | background dark-color-bg1 15 | color dark-color-text2 16 | overflow-y auto 17 | 18 | * 19 | box-sizing inherit 20 | 21 | .flex-spacer 22 | flex 1 23 | 24 | #app 25 | height 100% 26 | width 100% 27 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM node:alpine as build 2 | WORKDIR /build 3 | COPY ./ ./ 4 | RUN npm install gulp 5 | RUN npm run dist 6 | 7 | FROM node:alpine 8 | # TODO: This needed? 9 | RUN apk --no-cache add curl 10 | EXPOSE 3000 11 | WORKDIR /app 12 | COPY *.* ./ 13 | COPY --from=build /build/package-lock.json ./ 14 | RUN npm ci --only=production 15 | COPY --from=build /build/public ./public 16 | COPY server ./server 17 | CMD ["node", "server/index.js"] 18 | -------------------------------------------------------------------------------- /assets/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "courier", 3 | "short_name": "courier", 4 | "icons": [ 5 | { 6 | "src": "android-chrome-192x192.png", 7 | "sizes": "192x192", 8 | "type": "image/png" 9 | }, 10 | { 11 | "src": "android-chrome-512x512.png", 12 | "sizes": "512x512", 13 | "type": "image/png" 14 | } 15 | ], 16 | "theme_color": "#000000", 17 | "background_color": "#000000", 18 | "start_url": "/", 19 | "display": "standalone" 20 | } 21 | -------------------------------------------------------------------------------- /client/lib/request.js: -------------------------------------------------------------------------------- 1 | function req (url, method = 'GET', params) { 2 | const opts = { 3 | method: method, 4 | headers: { 'Content-Type': 'application/json' } 5 | }; 6 | if (params) { 7 | opts.body = JSON.stringify(params); 8 | if (params.id) url += `/${params.id}`; 9 | } 10 | return fetch(`api${url}`, opts).then(res => res.json()); 11 | } 12 | 13 | export const get = url => req(url); 14 | export const post = (url, params) => req(url, 'POST', params); 15 | export const del = url => req(url, 'DELETE'); 16 | -------------------------------------------------------------------------------- /client/lib/utils.js: -------------------------------------------------------------------------------- 1 | function formatNumber (num) { 2 | num = Math.round(0 + num * 100) / 100; 3 | return num.toLocaleString('en-GB', { minimumFractionDigits: 2 }); 4 | } 5 | 6 | 7 | function slugify (text) { 8 | return text.toString().toLowerCase().trim() 9 | .replace(/&/g, '-and-') // Replace & with 'and' 10 | .replace(/[\s\W-]+/g, '-') 11 | .replace(/-{2,}/g, '-') // Replace multiple - with single - 12 | .replace(/^-+/, '') // Trim - from start of text 13 | .replace(/-+$/, ''); // Trim - from end of text 14 | } 15 | 16 | 17 | export { 18 | formatNumber, 19 | slugify, 20 | }; 21 | -------------------------------------------------------------------------------- /client/tracking/tracking-number.svelte: -------------------------------------------------------------------------------- 1 |
2 | {#if (link)} {value} 3 | {:else} {value} 4 | {/if} 5 |
6 | 7 | 22 | -------------------------------------------------------------------------------- /client/lib/pubsub.js: -------------------------------------------------------------------------------- 1 | const _cache = {}; 2 | 3 | function fire (topic, ...args) { 4 | if (!_cache[topic]) return; 5 | _cache[topic].forEach(cb => { 6 | if (typeof cb === 'function') cb.apply(cb, args); 7 | }); 8 | } 9 | 10 | function on (topic, callback) { 11 | if (!_cache[topic]) _cache[topic] = []; 12 | _cache[topic].push(callback); 13 | return [topic, callback]; // handle for off 14 | } 15 | 16 | function off (handle) { 17 | let [topic, cb] = handle, ca = _cache[topic]; 18 | cb = cb.toString(); 19 | if (ca) { 20 | ca.forEach((fn, i) => { 21 | if (fn.toString() === cb) ca.splice(i, 1); 22 | }); 23 | } 24 | } 25 | 26 | 27 | export { 28 | on, 29 | off, 30 | fire 31 | }; 32 | -------------------------------------------------------------------------------- /client/header/index.styl: -------------------------------------------------------------------------------- 1 | @import "lib" 2 | 3 | 4 | .header 5 | background dark-color-bg3 6 | border-bottom dark-color-bg2 7 | position sticky 8 | top 0 9 | padding 0 20 10 | display flex 11 | flex-wrap wrap 12 | align-items center 13 | justify-content space-between 14 | z-index 10 15 | 16 | .logo 17 | size 40 18 | margin-right 10 19 | 20 | h1 21 | flex 1 22 | font-weight 400 23 | font-family 'Courier New', Courier, monospace 24 | 25 | input 26 | .select-wrap 27 | flex 1 28 | margin-right 6 29 | min-width 50 30 | 31 | form 32 | display flex 33 | align-items center 34 | justify-content space-between 35 | flex-wrap wrap 36 | padding 0 0 10 37 | min-width 100% 38 | 39 | 40 | form.loading 41 | opacity 0.5 42 | pointer-events none 43 | -------------------------------------------------------------------------------- /client/main/index.svelte: -------------------------------------------------------------------------------- 1 |
2 | {#if loading} 3 |
Loading...
4 | {:else} 5 | {#if $trackings && $trackings.length} 6 | {#each $trackings as tracking} 7 | 8 | {/each} 9 | {:else if firstTimeLoaded} 10 |
No trackings found.
11 | {/if} 12 | {/if} 13 |
14 | 15 | 16 | 41 | -------------------------------------------------------------------------------- /.eslintrc: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "eslint:recommended", 3 | "env": { 4 | "es6": true, 5 | "node": true, 6 | "browser": true 7 | }, 8 | "parserOptions": { 9 | "sourceType": "module", 10 | "ecmaVersion": 2020 11 | }, 12 | "plugins": [ "svelte3" ], 13 | "overrides": [ 14 | { 15 | "files": "*.svelte", 16 | "processor": "svelte3/svelte3" 17 | } 18 | ], 19 | "rules": { 20 | "brace-style": ["error", "stroustrup", { "allowSingleLine": true }], 21 | "indent": [2, "tab"], 22 | "quotes": [2, "single", "avoid-escape"], 23 | "semi": [2, "always"], 24 | "func-call-spacing": ["error", "never"], 25 | "space-before-function-paren": ["error", "always"], 26 | "newline-per-chained-call": ["error", { "ignoreChainWithDepth": 3 }], 27 | "no-undef": 2, 28 | "no-mixed-spaces-and-tabs": 2, 29 | "no-unused-vars": 1, 30 | "no-trailing-spaces": 2, 31 | "no-shadow": 2, 32 | "eol-last": 1, 33 | "no-console": 0, 34 | "comma-dangle": 0, 35 | "no-cond-assign": 0 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /server/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | Courier 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 |
24 | 25 | 26 | -------------------------------------------------------------------------------- /server/index.js: -------------------------------------------------------------------------------- 1 | require('dotenv').config(); 2 | 3 | const path = require('path'); 4 | const express = require('express'); 5 | const bodyParser = require('body-parser'); 6 | const {logger, isDev} = require('./lib'); 7 | const app = express(); 8 | const api = require('./api/'); 9 | const port = process.env.PORT || 3000; 10 | 11 | function sendView (res, view) { 12 | res.sendFile(view, { root: __dirname }); 13 | } 14 | 15 | function rootPath (req, res) { 16 | if (req.path.substr(1)) return res.redirect('/'); 17 | sendView(res, 'index.html'); 18 | } 19 | 20 | 21 | if (isDev) app.use(require('connect-livereload')()); 22 | 23 | app.use(bodyParser.urlencoded({ extended: false })); 24 | app.use(bodyParser.json()); 25 | 26 | app.use('/api/', api); 27 | app.use('/', express.static(path.join(__dirname, '..', 'public'))); 28 | app.use('/', rootPath); 29 | 30 | logger.info('--- STARTING -----------------------------------------------------'); 31 | app.listen(port, () => logger.info('Server started: http://localhost:' + port)); 32 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # courier 2 | A self-hosted parcel tracker. 3 | Heavily inspired by [ParcelPony](https://github.com/fireshaper/parcelpony). 4 | 5 | ## Features 6 | - nodejs version 7 | - docker & docker-compose 8 | - track almost any courier in the world 9 | 10 | ## TODO 11 | - [ ] edit tracking? 12 | - [ ] don't reload on "delete", just remove item from the list 13 | - [ ] don't reload on on "add" - add item immediately, then reload in bg 14 | - [ ] maybe add "force reload" option to invalidate cache? 15 | 16 | 17 | 18 | 19 | ## Setup 20 | ### Prerequisities 21 | - Register at [trackinghive](https://my.trackinghive.com/) and get the API token (In Settings/API Keys) 22 | 23 | ### Run 24 | Use this `docker-compose.yml`: 25 | ```yml 26 | --- 27 | version: '3.7' 28 | services: 29 | courier: 30 | container_name: courier 31 | image: tborychowski/courier 32 | restart: unless-stopped 33 | ports: 34 | - "3000:3000" 35 | environment: 36 | - NODE_ENV=production 37 | - TOKEN= 38 | 39 | ``` 40 | That's it! 41 | Now you can add & track your parcels from the web interface. 42 | -------------------------------------------------------------------------------- /server/lib/logger.js: -------------------------------------------------------------------------------- 1 | const winston = require('winston'); 2 | require('winston-daily-rotate-file'); 3 | 4 | function print (info) { 5 | const {timestamp, level, message} = info; 6 | const ts = timestamp.slice(0, 19).replace('T', ' '); 7 | return `${ts} [${level}] ${message}`; 8 | } 9 | 10 | const fileFormat = winston.format.combine( 11 | winston.format.timestamp(), 12 | winston.format.printf(print) 13 | ); 14 | 15 | const consoleFormat = winston.format.combine( 16 | winston.format.colorize(), 17 | winston.format.timestamp({ format: '[[]HH:mm:ss[]]' }), 18 | winston.format.printf(print) 19 | ); 20 | 21 | const fileLog = new winston.transports.DailyRotateFile({ 22 | filename: 'logs/%DATE%.log', 23 | datePattern: 'YYYY-MM-DD', 24 | // zippedArchive: true, 25 | maxSize: '20m', 26 | maxFiles: '7d' 27 | }); 28 | 29 | const errorLog = new winston.transports.File({ filename: 'logs/error.log', level: 'error' }); 30 | const consoleLog = new winston.transports.Console({ format: consoleFormat }); 31 | 32 | 33 | const logger = winston.createLogger({ 34 | level: 'info', 35 | format: fileFormat, 36 | transports: [ 37 | errorLog, 38 | fileLog, 39 | consoleLog 40 | ] 41 | }); 42 | 43 | module.exports = logger; 44 | -------------------------------------------------------------------------------- /client/header/index.svelte: -------------------------------------------------------------------------------- 1 |
2 | 3 |

courier

4 |
5 | 6 | 7 |
8 | 14 |
15 | 16 |
17 |
18 | 19 | 20 | 46 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "courier", 3 | "version": "0.0.10", 4 | "license": "GPL-3.0-or-later", 5 | "repository": { 6 | "type": "git", 7 | "url": "" 8 | }, 9 | "scripts": { 10 | "start:client": "gulp", 11 | "start:server": "gulp server", 12 | "dist": "gulp prod", 13 | "start": "run-p start:client start:server" 14 | }, 15 | "dependencies": { 16 | "axios": "1.6.x", 17 | "body-parser": "1.20.x", 18 | "connect-livereload": "0.6.x", 19 | "dotenv": "16.3.x", 20 | "express": "4.18.x", 21 | "fs-extra": "11.2.x", 22 | "winston": "3.11.x", 23 | "winston-daily-rotate-file": "4.7.x" 24 | }, 25 | "devDependencies": { 26 | "@rollup/plugin-commonjs": "^15.0.0", 27 | "@rollup/plugin-node-resolve": "^9.0.0", 28 | "chalk": "^4.1.0", 29 | "del": "^5.1.0", 30 | "detect-indent": "^6.0.0", 31 | "eslint-plugin-svelte3": "^2.7.3", 32 | "gulp": "^4.0.2", 33 | "gulp-concat": "^2.6.1", 34 | "gulp-eslint": "^6.0.0", 35 | "gulp-livereload": "^4.0.2", 36 | "gulp-nodemon": "^2.5.0", 37 | "gulp-sourcemaps": "^2.6.5", 38 | "gulp-stylus": "^2.7.0", 39 | "inquirer": "^7.3.3", 40 | "npm-run-all": "^4.1.5", 41 | "ora": "^5.0.0", 42 | "rollup": "^2.26.6", 43 | "rollup-plugin-svelte": "^6.0.0", 44 | "rollup-plugin-terser": "^7.0.0", 45 | "semver": "^7.3.2", 46 | "simple-git": "^2.20.1", 47 | "svelte": "^3.24.1", 48 | "through2": "^4.0.2", 49 | "vinyl-source-stream": "^2.0.0" 50 | } 51 | } 52 | -------------------------------------------------------------------------------- /client/toaster/index.styl: -------------------------------------------------------------------------------- 1 | @import "lib" 2 | 3 | .toaster 4 | position fixed 5 | width 400 6 | left 50% 7 | transform translateX(-50%) 8 | padding-top 5 9 | display flex 10 | flex-flow column 11 | align-items stretch 12 | user-select none 13 | z-index 90 14 | 15 | .toaster-top 16 | top 0 17 | .toaster-bottom 18 | bottom 0 19 | 20 | .toast 21 | position relative 22 | overflow hidden 23 | flex 1 24 | margin-top 5 25 | margin-bottom 5 26 | text-align center 27 | box-shadow 0 10px 20px 2px #0003 28 | z-index 10 29 | font-size 15px 30 | display flex 31 | align-items center 32 | justify-content space-between 33 | min-height 30 34 | border-radius 25 35 | 36 | button 37 | font inherit 38 | background none 39 | border none 40 | height 30px 41 | min-width 38px 42 | padding 0 10px 43 | display flex 44 | align-items center 45 | justify-content center 46 | transition background-color .2s 47 | color dark-color-text2 48 | 49 | &:hover 50 | color dark-color-text3 51 | background #3338 52 | &:active 53 | color dark-color-text1 54 | background #0008 55 | 56 | .toast-msg 57 | color dark-color-text2 58 | flex 1 59 | 60 | .toast-close 61 | font-size 22px 62 | font-weight 200 63 | border-radius 0 25px 25px 0 64 | position relative 65 | 66 | 67 | .toast 68 | .toast-info 69 | background color-info 70 | 71 | .toast-warning 72 | background color-warning 73 | 74 | .toast-error 75 | background color-danger 76 | 77 | .toast-progressbar 78 | position absolute 79 | bottom 1 80 | left 1 81 | right 1 82 | top 1 83 | border-radius 25 84 | overflow hidden 85 | z-index -1 86 | 87 | .toast-progress 88 | height 100% 89 | border-radius 25 90 | background-color #fff1 91 | width 0 92 | transition width .2s 93 | -------------------------------------------------------------------------------- /client/ui-style/button.styl: -------------------------------------------------------------------------------- 1 | @import "lib" 2 | 3 | button 4 | font inherit 5 | display inline-block 6 | padding 2 15 0 7 | min-width 32px 8 | min-height 32px 9 | margin-bottom 0 10 | font 15/1.4 11 | font-weight 400 12 | height auto; 13 | text-align center 14 | white-space nowrap 15 | vertical-align middle 16 | text-decoration none 17 | cursor default 18 | border transparent 19 | border-radius 3 20 | user-select none 21 | overflow hidden 22 | text-overflow ellipsis 23 | box-shadow 0 1px 0 rgba(#000, .8) 24 | color dark-color-text3 25 | transition background-color .3s ease-out, border-color .3s ease-out, box-shadow .3s ease-out 26 | background color-info 27 | vertical-align middle 28 | 29 | &:focus 30 | border-color dark-color-accent 31 | box-shadow 0 0 2px 1px dark-color-accent 32 | outline none 33 | 34 | &:active 35 | outline none 36 | box-shadow none 37 | transform translateY(1px) 38 | background darken(color-info, 15%) 39 | color alpha(dark-color-text3, 50%) 40 | 41 | 42 | 43 | &.success 44 | background darken(color-success, 30%) 45 | 46 | &:active 47 | background darken(color-success, 15%) 48 | 49 | 50 | &.warning 51 | background color-warning 52 | 53 | &:active 54 | background darken(color-warning, 15%) 55 | 56 | 57 | &.danger 58 | background color-danger 59 | 60 | &:active 61 | background darken(color-danger, 15%) 62 | 63 | 64 | &.text-icon 65 | font-size 20px 66 | padding 0 67 | 68 | 69 | &.icon 70 | height 32px 71 | width 32px 72 | border dark-color-bg2 73 | background none 74 | text-align center 75 | cursor pointer 76 | z-index 10 77 | color dark-color-text0 78 | transition color .2s 79 | 80 | &:focus 81 | border-color dark-color-accent 82 | box-shadow 0 0 2px 1px dark-color-accent 83 | color dark-color-text2 84 | 85 | &:hover 86 | color dark-color-text2 87 | &:active 88 | background dark-color-bg2 89 | 90 | 91 | .flex-spacer 92 | flex 1 93 | -------------------------------------------------------------------------------- /client/tracking/index.svelte: -------------------------------------------------------------------------------- 1 |
2 |
3 | 4 |
{data.status}
5 |

{data.title || 'Parcel'}

6 |
7 | 8 |
9 |
10 | 11 | 12 | 13 | 15 | 16 | 17 |
Expected:{data.expected} ({data.expectedIn}) 14 |
Picked up:{data.pickupDate} ({data.pickupAgo})
18 |
19 |
20 |
21 | {#if data.checkpoints.length} 22 |
23 | Checkpoints 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | {#each data.checkpoints as checkpoint} 32 | 33 | 34 | 35 | 36 | 37 | {/each} 38 | 39 |
DateLocationStatus
{(checkpoint.time || '').replace('T', ' ')}{checkpoint.location}{checkpoint.msg}
40 |
41 | {/if} 42 |
43 |
44 | 46 | 47 |
48 |
49 | 50 | 51 | 64 | -------------------------------------------------------------------------------- /server/api/index.js: -------------------------------------------------------------------------------- 1 | const express = require('express'); 2 | const api = express.Router(); 3 | const {logger, get, post, del} = require('../lib'); 4 | 5 | const AUTH = { Authorization: 'Bearer ' + process.env.TOKEN }; 6 | const msgMap = { 7 | 401: 'Auth token is invalid.', 8 | 409: 'Parcel is already added.', 9 | 429: 'Too many requests. Please wait 10 seconds and try again.', 10 | 500: 'Internal server error.' 11 | }; 12 | 13 | function catchError (e, res) { 14 | const code = e && e.response && e.response.status || 500; 15 | let msg = msgMap[code] || e.response.statusText; 16 | if (e.response.data && e.response.data.meta && e.response.data.meta.message && e.response.data.meta.message.length > 0) { 17 | msg += `: ${ e.response.data.meta.message.join('. ') }`; 18 | } 19 | logger.error(msg); 20 | res.status(code).json({ code, msg }); 21 | } 22 | 23 | 24 | // get list of couriers (cache 1 day) 25 | api.get('/courier', (req, res) => { 26 | get('/couriers/list', {}, 86400) 27 | .then(({code, data}) => res.status(code).json(data)); 28 | }); 29 | 30 | 31 | // get list of parcels (cache 30 seconds) 32 | api.get('/trackings', (req, res) => { 33 | get('/trackings?pageId=1&limit=100', AUTH, 30) 34 | .then(({code, data}) => res.status(code).json(data)) 35 | .catch(e => catchError(e, res)); 36 | }); 37 | 38 | 39 | // add parcel to tracking list 40 | api.post('/trackings', (req, res) => { 41 | const params = { 42 | tracking_number: req.body.tracking_number, 43 | slug: req.body.courier, 44 | custom_fields: { title: req.body.title } 45 | }; 46 | post('/trackings', params, AUTH) 47 | .then(({code, data}) => res.status(code).json(data)) 48 | .catch(e => catchError(e, res)); 49 | }); 50 | 51 | 52 | // delete parcel from tracking list 53 | api.delete('/trackings/:id', (req, res) => { 54 | del('/trackings/' + req.params.id, AUTH) 55 | .then(({code}) => res.status(code).json({result: 'success'})) 56 | .catch(e => catchError(e, res)); 57 | }); 58 | 59 | 60 | 61 | api.get('/', (req, res) => res.send('Hello from API!')); 62 | 63 | module.exports = api; 64 | -------------------------------------------------------------------------------- /server/lib/request.js: -------------------------------------------------------------------------------- 1 | const axios = require('axios'); 2 | const path = require('path'); 3 | const fs = require('fs-extra'); 4 | const logger = require('./logger'); 5 | 6 | const cachePath = path.join(__dirname, '..', 'cache'); 7 | 8 | axios.defaults.baseURL = 'https://api.trackinghive.com'; 9 | 10 | 11 | function getFname (_path) { 12 | const slug = _path.split(/[?#]/)[0] 13 | .replace(/\//g, '-') 14 | .replace(/^-|-$/g, '') + '.json'; 15 | return path.join(cachePath, slug); 16 | } 17 | 18 | 19 | function setCache (_path, data) { 20 | const fname = getFname(_path); 21 | logger.info('Caching response for: ' + _path); 22 | fs.writeJSONSync(fname, data, 'utf8'); 23 | } 24 | 25 | function clearCache (_path) { 26 | const fname = getFname(_path); 27 | logger.info('Clearing cache for: ' + _path); 28 | fs.unlinkSync(fname); 29 | } 30 | 31 | 32 | function getCache (_path, timeout = 0) { 33 | const fname = getFname(_path); 34 | if (!fs.existsSync(fname)) return; 35 | 36 | const now = +new Date(); 37 | const mtime = fs.statSync(fname).mtimeMs; 38 | const valid_until = mtime + timeout * 1000; 39 | if (valid_until < now) return; 40 | 41 | const data = fs.readJSONSync(fname, 'utf8'); 42 | logger.info('Using cached response for: ' + _path); 43 | return data; 44 | } 45 | 46 | 47 | 48 | function get (_path, headers = {}, cache_timeout_in_seconds) { 49 | const cached = getCache(_path, cache_timeout_in_seconds); 50 | if (cached) return Promise.resolve(cached); 51 | return axios 52 | .get(_path, { headers }) 53 | .then(({data}) => { 54 | const resp = {code: data.meta.code, data: data.data }; 55 | setCache(_path, resp); 56 | return resp; 57 | }); 58 | } 59 | 60 | 61 | function post (_path, params, headers = {}) { 62 | return axios 63 | .post(_path, params, { headers }) 64 | .then(({data}) => { 65 | clearCache('/trackings'); 66 | return {code: data.meta.code, data: data.data }; 67 | }); 68 | } 69 | 70 | 71 | function del (_path, headers = {}) { 72 | return axios 73 | .delete(_path, { headers }) 74 | .then(({data}) => { 75 | clearCache('/trackings'); 76 | return {code: data.meta.code, data: data.data }; 77 | }); 78 | } 79 | 80 | 81 | module.exports = { 82 | get, 83 | post, 84 | del 85 | }; 86 | -------------------------------------------------------------------------------- /client/toaster/index.svelte: -------------------------------------------------------------------------------- 1 |
2 | {#each toasts as toast (toast.id)} 3 |
6 |
{toast.msg}
7 | {#if toast.btn} 8 | 9 | {/if} 10 | 11 | {#if toast.showProgress} 12 |
13 |
14 |
15 | {/if} 16 |
17 | {/each} 18 |
19 | 20 | 21 | 57 | 58 | 81 | -------------------------------------------------------------------------------- /client/ui-style/form.styl: -------------------------------------------------------------------------------- 1 | @import "lib" 2 | 3 | *::-moz-focus-inner 4 | padding 0 !important 5 | border none !important 6 | 7 | 8 | .select-wrap 9 | textarea 10 | input[type=text] 11 | input[type="color"] 12 | input[type="number"] 13 | font inherit 14 | height 34 15 | border dark-color-bg2 16 | background-color dark-color-bg2 17 | color dark-color-text3 18 | transition background-color .3s ease-out, 19 | border-color .3s ease-out, 20 | box-shadow .3s ease-out, 21 | opacity .3s ease-out 22 | border-radius 4px 23 | 24 | &:disabled 25 | opacity 0.5 26 | 27 | &:focus 28 | &:focus-within 29 | border-color dark-color-accent 30 | box-shadow 0 0 2px 1px dark-color-accent 31 | outline none 32 | 33 | &:invalid 34 | border-color color-danger 35 | box-shadow 0 0 2px 1px color-danger 36 | outline none 37 | 38 | 39 | 40 | 41 | .select-wrap 42 | position relative 43 | display inline-block 44 | &:after 45 | content '' 46 | position absolute 47 | width 20 48 | height 12 49 | right 0 50 | top 10 51 | pointer-events none 52 | background-repeat no-repeat 53 | background-position right .75rem center 54 | background-size 8px 10px 55 | background-image url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 4 5'%3E%3Cpath fill='%23eeeeee' d='M2 0L0 2h4zm0 5L0 3h4z'/%3E%3C/svg%3E") 56 | 57 | 58 | select 59 | font inherit 60 | color inherit 61 | border none 62 | border-radius 4px 63 | background none 64 | background-color inherit 65 | line-height 16px 66 | padding 2 22 0 10 67 | width 100% 68 | height 100% 69 | text-indent -2px 70 | -webkit-appearance none 71 | -moz-appearance none 72 | appearance none 73 | &:focus 74 | outline none 75 | 76 | :disabled 77 | color dark-color-text0 78 | 79 | textarea 80 | input[type=text] 81 | line-height 16px 82 | padding 3 10 0 83 | 84 | 85 | textarea 86 | min-height 4em 87 | resize vertical 88 | flex 1 89 | 90 | 91 | input[type=checkbox] 92 | input[type=radio] 93 | vertical-align inherit 94 | transform scale(1.4) 95 | filter hue-rotate(-12deg) saturate(.4) 96 | margin-right 6px 97 | 98 | 99 | input[type="color"] 100 | -webkit-appearance none 101 | -moz-appearance none 102 | appearance none 103 | background none 104 | border none 105 | padding 0 106 | cursor pointer 107 | 108 | input[type="number"] 109 | text-align center 110 | 111 | 112 | input[type=file] 113 | position absolute 114 | right -500px 115 | 116 | 117 | label 118 | display block 119 | height 34 120 | line-height 16px 121 | padding 9 5 0 122 | 123 | &.disabled 124 | opacity 0.3 125 | -------------------------------------------------------------------------------- /client/tracking/index.styl: -------------------------------------------------------------------------------- 1 | @import "lib" 2 | 3 | .tracking 4 | background dark-color-bg3 5 | padding 20 6 | margin 0 0 1 7 | position relative 8 | overflow hidden 9 | 10 | header 11 | footer 12 | display flex 13 | align-items center 14 | justify-content flex-start 15 | flex-wrap wrap 16 | 17 | footer 18 | align-items flex-start 19 | 20 | .flex-spacer 21 | max-width 50px 22 | flex 1 23 | 24 | .sub-header 25 | margin 10 0 0 26 | table 27 | border-collapse collapse 28 | color dark-color-text0 29 | td 30 | padding 5 31 | .highlight 32 | color dark-color-text2 33 | 34 | h2 35 | font-weight 400 36 | font-size 18px 37 | text-transform uppercase 38 | 39 | .details 40 | margin 20 20 0 0 41 | flex 1 42 | cursor pointer 43 | color dark-color-text0 44 | 45 | em 46 | font-style normal 47 | color dark-color-accent 48 | 49 | .Delivered em 50 | color color-success 51 | 52 | 53 | .tracking-number 54 | color dark-color-text0 55 | margin 0 10 56 | 57 | a 58 | color inherit 59 | position relative 60 | 61 | &:after 62 | content '↗' 63 | position absolute 64 | top 0 65 | right -14 66 | font-size 11px 67 | font-weight 900 68 | opacity 0 69 | color dark-color-text3 70 | transition opacity .3s ease-out 71 | 72 | &:hover 73 | &:after 74 | opacity 1 75 | 76 | .status 77 | color dark-color-text0 78 | margin 0 10 0 0 79 | background dark-color-bg2 80 | padding 6 10 5 81 | border-radius 10 82 | 83 | 84 | .logo 85 | size 40 86 | min-size 40 87 | font-size 12px 88 | background #fff 89 | color #000 90 | display inline-flex 91 | align-items center 92 | text-align center 93 | margin 0 10 0 0 94 | overflow hidden 95 | border-radius 25px 96 | border 1px solid dark-color-bg1 97 | 98 | .checkpoints 99 | width 100% 100 | margin 10 0 101 | border-collapse collapse 102 | color dark-color-text2 103 | 104 | td 105 | border 1px solid dark-color-bg1 106 | padding 5 10 107 | 108 | thead td 109 | font-weight 600 110 | background dark-color-bg2 111 | padding 10 112 | 113 | 114 | .col-date 115 | width 160 116 | .col-location 117 | width 200 118 | .col-status 119 | width auto 120 | 121 | 122 | 123 | 124 | @media only screen and (max-device-width: 500px) 125 | .tracking 126 | .status 127 | position absolute 128 | right 5 129 | top 30 130 | .tracking-number 131 | display block 132 | width 100% 133 | margin 20 0 0 5 134 | 135 | &:before 136 | content: 'Tracking number: ' 137 | a:after 138 | opacity 1 139 | -------------------------------------------------------------------------------- /gulpfile.js: -------------------------------------------------------------------------------- 1 | const { series, parallel, src, dest, watch } = require('gulp'); 2 | const del = require('del'); 3 | const livereload = require('gulp-livereload'); 4 | 5 | const DIST_PATH = 'public/'; 6 | const env = process.env.NODE_ENV; 7 | let isProd = (env === 'production' || env === 'prod'); 8 | 9 | const setProd = (done) => { isProd = true; done(); }; 10 | 11 | 12 | function eslint () { 13 | const gulpEslint = require('gulp-eslint'); 14 | return src(['client/**/*.js', 'client/**/*.svelte', 'server/**/*.js', '*.js']) 15 | .pipe(gulpEslint()) 16 | .pipe(gulpEslint.format()) 17 | .pipe(gulpEslint.results(results => { 18 | if (results.errorCount) console.log('\x07'); // beep 19 | })); 20 | } 21 | 22 | 23 | function rollupBuild (inputOptions = {}, outputOptions = {}) { 24 | const stream = require('stream'); 25 | const rollup = require('rollup'); 26 | const readable = new stream.Readable(); 27 | 28 | readable._read = function () { }; 29 | rollup 30 | .rollup(inputOptions) 31 | .then(bundle => bundle.generate(outputOptions)) 32 | .then(out => { 33 | if (!out.code) out = out.output[0]; 34 | readable.push(out.code); 35 | if (outputOptions.output.sourcemap) { 36 | readable.push('\n//# sourceMappingURL='); 37 | readable.push(out.map.toUrl()); 38 | } 39 | readable.push(null); 40 | }) 41 | .catch(error => setTimeout(() => readable.emit('error', error))); 42 | return readable; 43 | } 44 | 45 | 46 | function js () { 47 | const commonjs = require('@rollup/plugin-commonjs'); 48 | const source = require('vinyl-source-stream'); 49 | const svelte = require('rollup-plugin-svelte'); 50 | const {nodeResolve} = require('@rollup/plugin-node-resolve'); 51 | const {terser} = require('rollup-plugin-terser'); 52 | 53 | const inputOptions = { 54 | input: './client/index.js', 55 | plugins: [ 56 | commonjs(), 57 | nodeResolve({ 58 | extensions: ['.mjs', '.js', '.svelte', '.json'], 59 | dedupe: importee => importee === 'svelte' || importee.startsWith('svelte/') 60 | }), 61 | svelte({ dev: !isProd, css: false }), 62 | isProd && terser() 63 | ] 64 | }; 65 | const outputOptions = {output: {format: 'iife', sourcemap: !isProd}}; 66 | return rollupBuild(inputOptions, outputOptions) 67 | .pipe(source('index.js')) 68 | .pipe(dest(DIST_PATH)) 69 | .pipe(livereload()); 70 | } 71 | 72 | 73 | function css () { 74 | const noop = require('through2').obj; 75 | const sourcemap = require('gulp-sourcemaps'); 76 | const stylus = require('gulp-stylus'); 77 | const concat = require('gulp-concat'); 78 | return src(['client/**/*.styl']) 79 | .pipe(isProd ? noop() : sourcemap.init()) 80 | .pipe(stylus({ paths: ['client/ui-style'], compress: isProd, 'include css': true })) 81 | .pipe(concat('index.css')) 82 | .pipe(isProd ? noop() : sourcemap.write()) 83 | .pipe(dest(DIST_PATH)) 84 | .pipe(livereload()); 85 | } 86 | 87 | 88 | let serverStarted = false; 89 | function server (done) { 90 | const nodemon = require('gulp-nodemon'); 91 | nodemon({ script: './server/index.js', watch: ['./server'], ext: 'js html' }) 92 | .on('start', () => { 93 | if (serverStarted) return; 94 | serverStarted = true; 95 | setTimeout(done, 500); 96 | }); 97 | } 98 | 99 | 100 | function assets () { 101 | return src(['assets/**/*.*']).pipe(dest(DIST_PATH)); 102 | } 103 | 104 | function cleanup () { 105 | return del([DIST_PATH + '/*']); 106 | } 107 | 108 | function watchTask (done) { 109 | if (isProd) return done(); 110 | livereload.listen(); 111 | watch('client/**/*.styl', css); 112 | watch('client/**/*.{js,svelte}', parallel(eslint, js)); 113 | watch('assets/**/*.*', assets); 114 | } 115 | 116 | const build = parallel(eslint, js, css, assets); 117 | exports.lint = eslint; 118 | exports.build = series(cleanup, build); 119 | exports.server = server; 120 | exports.default = series(build, watchTask); 121 | exports.prod = series(setProd, build); 122 | -------------------------------------------------------------------------------- /client/lib/store.js: -------------------------------------------------------------------------------- 1 | import {writable} from 'svelte/store'; 2 | import * as api from './request'; 3 | 4 | export const couriers = writable([]); 5 | export const trackings = trackingsStore(); 6 | 7 | 8 | function trackingsStore () { 9 | const { subscribe, set } = writable(0); 10 | set([]); 11 | return { 12 | subscribe, 13 | load: () => api.get('/trackings') 14 | .then(res => Array.isArray(res) ? res.map(remapFields) : []) 15 | .then(sortByDate) 16 | .then(set), 17 | add: (data) => api.post('/trackings', data).then(res => { 18 | if (res.code !== 200 && res.msg) alert(res.msg); 19 | }), 20 | del: (id) => api.del('/trackings/' + id), 21 | }; 22 | } 23 | 24 | 25 | 26 | api.get('/courier').then(res => { 27 | if (!res) return; 28 | res.sort((a, b) => a.title.localeCompare(b.title)); 29 | const _couriers = {}; 30 | res.forEach(c => _couriers[c.slug] = c); 31 | _couriers['an-post'].logo = _couriers['an-post'].logo || 'courier-anpost.png'; 32 | couriers.set(_couriers); 33 | }); 34 | 35 | 36 | function sortByDate (data) { 37 | data.sort((a, b) => a.sortField - b.sortField); 38 | return Promise.resolve(data); 39 | } 40 | 41 | 42 | function remapFields (data) { 43 | const _data = { id: data._id }; 44 | _data.tracking_number = data.tracking_number; 45 | _data.title = data.custom_fields && data.custom_fields.title || ''; 46 | _data.status = data.current_status; 47 | _data.courier = data.slug; 48 | _data.pickup_date = data.trackings && data.trackings.shipment_pickup_date || null; 49 | _data.sortField = +(_data.pickup_date ? new Date(_data.pickup_date) : new Date()); 50 | 51 | if (data.trackings) { 52 | // if (data.trackings.address) { 53 | // const _from = data.trackings.address.ship_from; 54 | // const _to = data.trackings.address.ship_to; 55 | // if (_from) { 56 | // _data.addrFrom = [_from.address_line1, _from.city, _from.country_name] 57 | // .filter(s => s && s.length) 58 | // .join(', '); 59 | // } 60 | // if (_to) { 61 | // _data.addrTo = [_to.address_line1, _to.city, _to.country_name] 62 | // .filter(s => s && s.length) 63 | // .join(', '); 64 | // } 65 | // } 66 | 67 | if (data.trackings.shipment_pickup_date) { 68 | const pickupDate = new Date(data.trackings.shipment_pickup_date); 69 | _data.pickupDate = pickupDate.toDateString() + ', ' + pickupDate.toLocaleTimeString(); 70 | _data.pickupAgo = data.trackings.delivery_time; 71 | _data.pickupAgo += ` day${_data.pickupAgo === 1 ? '' : 's'} ago`; 72 | } 73 | else { 74 | _data.pickupDate = ''; 75 | _data.pickupAgo = '?'; 76 | } 77 | 78 | if (_data.status === 'Delivered') { 79 | _data.expected = ''; 80 | _data.expectedIn = 'delivered'; 81 | } 82 | else if (data.trackings.expected_delivery) { 83 | const expectedDateStr = (data.trackings?.expected_delivery || '').substr(0, 10); 84 | const [yr, mo, day] = expectedDateStr.split('-'); 85 | const d = new Date(yr, mo - 1, day); 86 | _data.expected = d.toDateString(); 87 | 88 | const today = new Date(); 89 | const todayIso = today.toISOString().substr(0, 10); 90 | if (todayIso === data.trackings.expected_delivery) _data.expectedIn = 'today'; 91 | else { 92 | const _expectedIn = Math.ceil((+d - +today) / 86400000); 93 | if (_expectedIn > 1) _data.expectedIn = 'in ' + _expectedIn + ' days'; 94 | else if (_expectedIn === 1) _data.expectedIn = 'tomorrow'; 95 | else if (_expectedIn === 0) _data.expectedIn = 'today'; 96 | else if (_expectedIn < 0) _data.expectedIn = 'delayed'; 97 | else _data.expectedIn = '?'; 98 | } 99 | } 100 | else { 101 | _data.expected = ''; 102 | _data.expectedIn = '?'; 103 | } 104 | 105 | if (data.trackings.checkpoints) { 106 | _data.checkpoints = data.trackings.checkpoints.map(p => { 107 | return { time: p.checkpoint_time, location: p.location, msg: p.message }; 108 | }); 109 | } 110 | } 111 | return _data; 112 | } 113 | -------------------------------------------------------------------------------- /release.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | const {exec} = require('child_process'); 4 | const fs = require('fs'); 5 | const path = require('path'); 6 | const semver = require('semver'); 7 | const ora = require('ora'); 8 | const chalk = require('chalk'); 9 | const indent = require('detect-indent'); 10 | const inquirer = require('inquirer'); 11 | const git = require('simple-git')(); 12 | const cwd = process.cwd(); 13 | 14 | const APP = {}; 15 | const manifests = [ 'package.json' ]; 16 | const dryrun = false; 17 | const faker = arg => new Promise(resolve => setTimeout(() => resolve(arg), 2000)); 18 | 19 | function run (cmd) { 20 | if (dryrun) return faker(); 21 | return new Promise((resolve, reject) => { 22 | exec(cmd, (err, out) => (err ? reject(err) : resolve(out))); 23 | }); 24 | } 25 | 26 | 27 | function getVersion (manifest) { 28 | const pkgPath = path.join(cwd, manifest || manifests[0]); 29 | const pkg = require(pkgPath); 30 | const current = pkg.version || '0.0.0'; 31 | return { 32 | name: pkg.name, 33 | current: current, 34 | nextMajor: semver.inc(current, 'major'), 35 | nextMinor: semver.inc(current, 'minor'), 36 | nextPatch: semver.inc(current, 'patch') 37 | }; 38 | } 39 | 40 | 41 | function bump (manifest, newVersion) { 42 | const pkgPath = path.join(cwd, manifest); 43 | const pkg = require(pkgPath); 44 | const usedIndent = indent(fs.readFileSync(pkgPath, 'utf8')).indent || ' '; 45 | pkg.version = newVersion; 46 | if (!dryrun) fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, usedIndent) + '\n'); 47 | } 48 | 49 | 50 | function commit (version) { 51 | if (dryrun) return faker(); 52 | return new Promise((resolve, reject) => { 53 | git 54 | .silent(true) 55 | .add('./*') 56 | .commit('Release v' + version) 57 | .push(['origin', 'master'], err => { 58 | if (err) reject(err); 59 | else resolve({version}); 60 | }); 61 | }); 62 | } 63 | 64 | function release () { 65 | const app = getVersion(); 66 | APP.name = app.name; 67 | let spinner; 68 | console.log('\n********************************'); 69 | console.log('* *'); 70 | console.log(`* Releasing ${chalk.cyan(APP.name)} *`); 71 | console.log('* *'); 72 | console.log('********************************\n'); 73 | inquirer 74 | .prompt([ 75 | { 76 | type: 'list', 77 | name: 'version', 78 | message: 'Bump version to:', 79 | default: 1, 80 | choices: [ 81 | { value: app.current, name: 'current (' + app.current + ')' }, 82 | { value: app.nextPatch, name: 'patch (' + app.nextPatch + ')' }, 83 | { value: app.nextMinor, name: 'minor (' + app.nextMinor + ')' }, 84 | { value: app.nextMajor, name: 'major (' + app.nextMajor + ')' }, 85 | new inquirer.Separator(), 86 | { value: 'custom', name: 'custom...' }, 87 | ] 88 | }, 89 | { 90 | type: 'input', 91 | name: 'version', 92 | message: 'Enter the new version number:', 93 | default: app.current, 94 | when: answers => answers.version === 'custom', 95 | filter: semver.clean, 96 | validate: answer => semver.valid(answer) ? true : 'That\'s not a valid version number', 97 | } 98 | ]) 99 | .then(({version}) => { 100 | APP.version = version; 101 | spinner = ora('').start(); 102 | // update package & manifest 103 | manifests.forEach(m => { 104 | spinner.text = `Updating ${m}...`; 105 | bump(m, version); 106 | spinner.text = `Updated ${chalk.cyan(m)} to ${chalk.cyan(version)}`; 107 | spinner.succeed(); 108 | }); 109 | spinner.text = 'Committing to GitHub...'; 110 | spinner.start(); 111 | return commit(version); // commit code changes to github 112 | }) 113 | .then(() => { 114 | spinner.text = `Update ${chalk.cyan('pushed')} to Github.`; 115 | spinner.succeed(); 116 | 117 | spinner.text = 'Building & pushing a docker image...'; 118 | spinner.start(); 119 | const platforms = 'linux/arm/v7,linux/arm64/v8,linux/amd64'; 120 | const tagLatest = `tborychowski/${APP.name}:latest`; 121 | const tagVersion = `tborychowski/${APP.name}:${APP.version}`; 122 | return run(`docker buildx build --push --platform ${platforms} -t ${tagLatest} -t ${tagVersion} .`); 123 | }) 124 | .then(() => { 125 | spinner.text = 'Images pushed to ' + chalk.cyan('docker hub'); 126 | spinner.succeed(); 127 | console.log(chalk.cyan('All done!')); 128 | process.exit(0); 129 | }) 130 | .catch(e => { 131 | spinner.text = e; 132 | spinner.fail(); 133 | }); 134 | } 135 | 136 | 137 | release(); 138 | -------------------------------------------------------------------------------- /client/ui-style/lib.styl: -------------------------------------------------------------------------------- 1 | 2 | // VARS 3 | 4 | main-font = system,-apple-system,".SFNSDisplay-Regular","Helvetica Neue",Helvetica,"Segoe UI",sans-serif; 5 | img-base = "../assets" 6 | 7 | // DARK THEME 8 | dark-color-bg0 = #000 9 | dark-color-bg1 = #111 10 | dark-color-bg2 = #222 11 | dark-color-bg3 = #333 12 | dark-color-bg4 = #444 13 | 14 | dark-color-text0 = #888 15 | dark-color-text1 = #ccc 16 | dark-color-text2 = #eee 17 | dark-color-text3 = #fff 18 | 19 | dark-color-highlight = #637291 20 | dark-color-accent = orange 21 | 22 | dark-shadow = 0 1px 5px 1px rgba(#000, 0.5) 23 | 24 | 25 | color-info=#666d7b 26 | color-success=#408062 27 | color-warning=#af8a1a 28 | color-danger=#8b4848 29 | 30 | 31 | 32 | //*** SHORTCUTS ************************************************************************************ 33 | b(n) { if n is 0 { font-weight: normal } else { font-weight: bold } } // b:1 -> font-weight: bold; 34 | i(n) { if n is 0 { font-style: normal } else { font-style: italic } } // i:1 -> font-style: italic; 35 | u(n) { if n is 0 { text-decoration: none } else { text-decoration: underline } } // u:1 -> text-decoration: underline; 36 | 37 | padding() { padding: joinArgs(arguments) } 38 | padding-left(a) { padding-left: px(a) } 39 | padding-right(a) { padding-right: px(a) } 40 | padding-top(a) { padding-top: px(a) } 41 | padding-bottom(a) { padding-bottom: px(a) } 42 | 43 | margin() { margin: joinArgs(arguments) } 44 | margin-left(a) { margin-left: px(a) } 45 | margin-right(a) { margin-right: px(a) } 46 | margin-top(a) { margin-top: px(a) } 47 | margin-bottom(a) { margin-bottom: px(a) } 48 | 49 | size(w, h=w) { width: px(w); height: px(h); } 50 | min-size(w, h=w) { min-width: px(w); min-height: px(h); } 51 | max-size(w, h=w) { max-width: px(w); max-height: px(h); } 52 | 53 | width(n = 0) { width: px(n) } 54 | min-width(n = 0) { min-width: px(n) } 55 | max-width(n = 0) { max-width: px(n) } 56 | 57 | height(n = 0) { height: px(n) } 58 | min-height(n = 0) { min-height: px(n) } 59 | max-height(n = 0) { max-height: px(n) } 60 | 61 | top(n = 0) { top: px(n) } 62 | right(n = 0) { right: px(n) } 63 | left(n = 0) { left: px(n) } 64 | bottom(n = 0) { bottom: px(n) } 65 | 66 | z(n = 0) { z-index: n } 67 | //*** SHORTCUTS ************************************************************************************ 68 | 69 | 70 | // top, right, bottom, left 71 | pos() 72 | a = arguments 73 | position: absolute; 74 | unless type(a[0]) is not 'unit' { top: px(a[0]); } 75 | unless type(a[1]) is not 'unit' { right: px(a[1]); } 76 | unless type(a[2]) is not 'unit' { bottom: px(a[2]); } 77 | unless type(a[3]) is not 'unit' { left: px(a[3]); } 78 | 79 | 80 | font() 81 | if length(arguments) is 3 and type(arguments[1]) is 'literal' // font: 12/2 -> font-size: 12px; line-height: 2 82 | font-size: px(arguments[0]); 83 | line-height: arguments[2] 84 | else if length(arguments) is 1 // font: 13 -> font-size: 13px; 85 | if type(arguments[0]) == 'unit' 86 | font-size: px(arguments[0]); 87 | else 88 | font: arguments; 89 | else // use native font 90 | font: arguments; 91 | 92 | 93 | 94 | // border: [top] [1px] [solid] [blue], e.g. border: 1px; border: red; border: top blue; border: top 1px; border: top 2px dotted green; 95 | border-top() { border-top: setBorder(arguments); } 96 | border-right() { border-right: setBorder(arguments); } 97 | border-bottom() { border-bottom: setBorder(arguments); } 98 | border-left() { border-left: setBorder(arguments); } 99 | border() 100 | if arguments[0] == 'none' { border: none; } else { border: setBorder(arguments); } 101 | 102 | border-radius() { border-radius: joinArgs(arguments); } 103 | 104 | 105 | // set background, e.g. bg: red; bg: img x y; bg: red img; 106 | bg() 107 | arg = arguments 108 | if type(arg[0]) == 'rgba' 109 | if length(arg) > 1 110 | background: arg[0] setBg(arg[1], arg[2] || 0, arg[3] || 0, arg[4] || no-repeat) 111 | else 112 | background: arg[0] 113 | else 114 | if arguments[0] == 'none' 115 | background: none 116 | else 117 | background: setBg(arg[0], arg[1] || 0, arg[2] || 0, arg[3] || no-repeat) 118 | 119 | 120 | user-select() 121 | -moz-user-select: arguments; 122 | user-select: arguments; 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | //*** STYLE HELPERS ******************************************************************************** 131 | 132 | // border: [1px] [solid] [blue], e.g. border: 1; border: red; border: 1 red; border: 1 dotted red; 133 | setBorder() 134 | arg = arguments 135 | if arg[0] == 'none' 136 | return none 137 | else if type(arg[0]) == 'unit' 138 | size = arg[0] 139 | if type(arg[1]) == 'rgba' 140 | color = arg[1] 141 | style = solid 142 | else 143 | if type(arg[1]) == 'ident' 144 | style = arg[1] 145 | if type(arg[2]) == 'rgba' { color = arg[2] } else { color = transparent } 146 | else 147 | style = solid 148 | if arg[1] == null 149 | color = transparent 150 | else 151 | size = 1 152 | style = solid 153 | if type(arg[0]) == 'rgba' { color = arg[0] } 154 | 155 | return px(size) style color; 156 | 157 | 158 | setBg() 159 | arg = arguments 160 | return unquote('url(' + img-base + '/' + unquote(arg[0]) + ') ' + px(arg[1]) + ' ' + px(arg[2]) + ' ' + arg[3]); 161 | //*** STYLE HELPERS ******************************************************************************** 162 | 163 | 164 | 165 | 166 | 167 | //*** GENERIC HELPERS ****************************************************************************** 168 | px(a) 169 | if type(a) == 'unit' 170 | if unit(a) == 'px' || a == 0 { return a } else { return (a + 0px) } 171 | else 172 | return a 173 | 174 | // Joins arguments with space and adds "px" to values if needed 175 | joinArgs(args) 176 | buf = '' 177 | for arg, i in args 178 | if i { buf += ' ' + px(arg) } else { buf += px(arg) } 179 | return unquote(buf) 180 | //*** GENERIC HELPERS ****************************************************************************** 181 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------