Add LICENSE, GitHub link on page

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2019 Steven Spangler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

config.yml

@@ -5,28 +5,28 @@ admin_username: 'admin'
 # Plaintext password to make admin API requests
 # Safe to remove if admin_hashed_password is set
 # Default: unset
-admin_password: 'password'
+#admin_password:
 
 # Hashed password (bcrypt) to make admin API requests - Preferred over plaintext, use securepass.sh to generate
 # Please note that authentication takes noticeably longer than using plaintext password
 # Don't include the <username>: segment, just the hash
 # Default: unset (required to start application)
-#admin_hashed_password: '$2y$15$Dhll3IY42R.JNOYazarlG.8IndwMjxmHLpFsebJzcGTJd.gbsAwna'
+admin_hashed_password: '$2y$15$Dhll3IY42R.JNOYazarlG.8IndwMjxmHLpFsebJzcGTJd.gbsAwna'
 
-# Secret key used for cookies (used for storage of messages)
+# String: Secret key used for cookies (used for storage of messages)
 # This should be a 12-16 character randomized string with letters, numbers, and symbols
 # Default: unset (required to start application)
 secret_key: 'S$JI8L*&xua%gBoL'
 
-# Filename of the URL database
+# String: Filename of the URL database without extension
 # Default: 'urls'
 database_name: 'urls'
 
-# Length of random short URLs by default
+# Integer: Length of random short URLs by default
 # Default: 4
 random_length: 4
 
-# Allowed URL characters
+# String: Allowed URL characters
 # Default: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_
 allowed_chars: 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_'
 
@@ -34,11 +34,15 @@ allowed_chars: 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_
 # Default: 5
 random_gen_timeout: 5
 
-# Name shown on tab while on site and on page header
+# String: Name shown on tab while on site and on page header
 # Default: 'liteshort'
 site_name: 'liteshort'
 
-# URL shown when finished generating shortlinks. Include the / at the end.
+# String: URL shown when finished generating shortlinks. Include the / at the end.
 # If not set, it is automatically taken from the URL the shorten request is sent to.
 # Default: unset
-site_url:
+site_url:
+
+# Boolean: Show link to project repository on GitHub at bottom right corner of page
+# Default: true
+show_github_link: false

liteshort.py

@@ -1,3 +1,8 @@
+# Copyright (c) 2019 Steven Spangler <132@ikl.sh>
+# This file is part of liteshort by 132ikl
+# This software is license under the MIT license. It should be included in your copy of this software.
+# A copy of the MIT license can be obtained at https://mit-license.org/
+
 from flask import Flask, current_app, flash, g, jsonify, redirect, render_template, request, url_for
 import bcrypt
 import random
@@ -15,12 +20,13 @@ def load_config():
 
     req_options = {'admin_username': 'admin', 'database_name': "urls", 'random_length': 4,
                    'allowed_chars': 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_',
-                   'random_gen_timeout': 5, 'site_name': 'liteshort', 'site_url': None
+                   'random_gen_timeout': 5, 'site_name': 'liteshort', 'site_url': None, 'show_github_link': True,
+                   'secret_key': None
                    }
 
     config_types = {'admin_username': str, 'database_name': str, 'random_length': int,
                     'allowed_chars': str, 'random_gen_timeout': int, 'site_name': str,
-                    'site_url': (str, type(None))}
+                    'site_url': (str, type(None)), 'show_github_link': bool, 'secret_key': str}
 
     for option in req_options.keys():
         if option not in new_config.keys():  # Make sure everything in req_options is set in config

static/GitHub.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>

static/styles.css

@@ -1,3 +1,10 @@
+/*
+Copyright (c) 2019 Steven Spangler <132@ikl.sh>
+This file is part of liteshort by 132ikl
+This software is license under the MIT license. It should be included in your copy of this software.
+A copy of the MIT license can be obtained at https://mit-license.org/
+*/
+
 div.form {
   margin-top: 5%;
   text-align: center;
@@ -28,6 +35,11 @@ body {
   text-align: center
 }
 
+h2 {
+  font-weight: normal;
+  font-family: Open Sans;
+}
+
 div.success > a:link {
   color: #62ad2c;
 }
@@ -36,7 +48,19 @@ div.success > a:visited {
   color: #507c52;
 }
 
-h2 {
-  font-weight: normal;
-  font-family: Open Sans;
+div.github {
+  position: absolute;
+  transition: opacity .25s ease-out;
+  -moz-transition: opacity .25s ease-out;
+  -webkit-transition: opacity .25s ease-out;
+  -o-transition: opacity .25s ease-out;
+  opacity: 0.3;
+  right: 2.5%;
+  bottom: 10%;
+  width: 2.5%;
+  height: 2.5%;
+}
+
+div.github:hover {
+ opacity: 1; 
 }

templates/main.html

@@ -1,3 +1,9 @@
+<!--
+Copyright (c) 2019 Steven Spangler <132@ikl.sh>
+This file is part of liteshort by 132ikl
+This software is license under the MIT license. It should be included in your copy of this software.
+A copy of the MIT license can be obtained at https://mit-license.org/
+-->
 <!DOCTYPE html>
 <html lang="en">
 <head>
@@ -38,5 +44,12 @@
             {% endfor %}
         {% endif %}
     {% endwith %}
+    {% if config.show_github_link %}
+        <div class="github">
+            <a href="https://github.com/132ikl/liteshort">
+                <img src="{{ url_for('static', filename='GitHub.svg') }}">
+            </a>
+        </div>
+    {% endif %}
 </body>
 </html>