Merge pull request #79 from KCarlile/60-add-changelog-to-about-page

Issue #60: Add changelog to about page
KCarlile · Jun 1, 2022 · 21a6ef7 · 21a6ef7
2 parents 43f05bd + 60b7cd8
commit 21a6ef7
Show file tree

Hide file tree

Showing 22 changed files with 3,141 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,7 @@
 # Flash Chord Changelog
 
+**Current production release:** 1.7
+
 ---
 
 ## Release 2.0
@@ -11,6 +13,7 @@ Commit: <>
 
 - Fixed bug in debugging-enabled check (no issue).
 - Issue [#69](https://github.com/KCarlile/flashchord/issues/69): Fix logging redundancy
+- Issue [#60](https://github.com/KCarlile/flashchord/issues/60): Add changelog to About page
 
 ## Release 1.7
 

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# FlashChord
+# Flash Chord
 
 ## Functional
 
@@ -10,7 +10,7 @@ Preview new features and test new development at [http://dev.flashchord.com](htt
 
 ### Logging and Debugging
 
-Enable debugging in the browser console by adding `?dbg=1` to the URL. This will tell Flashchord to send logged messages to the console for viewing. Then, use the brower's console to view logging statements.
+Enable debugging in the browser console by adding `?dbg=1` to the URL. This will tell Flash Chord to send logged messages to the console for viewing. Then, use the browser's console to view logging statements.
 
 For logging functionality, see the `js/utils.js` file and look at the following functions:
 
@@ -23,17 +23,19 @@ For logging functionality, see the `js/utils.js` file and look at the following
 
 ## Technical
 
-- Twitter Bootstrap HTML/CSS theme
-- Javascript
+- Twitter Bootstrap HTML/CSS theme (4.5)
+- JavaScript
 - jQuery
 - PHP
+- [Parsedown for Markdown parsing](https://parsedown.org/)
+  - Composer for dependency management
 
 ## Creator
 
 Kenny Carlile
 
 - GitHub: @KCarlile
-- [http://www.kennycarlile.com/](http://www.kennycarlile.com/)
+- [http://www.kcarlile.com/](http://www.kcarlile.com/)
 
 ## Contributions
 
@@ -42,3 +44,9 @@ If you'd like to contribute, please contact Kenny Carlile through GitHub or his
 ## Contributors
 
 - _Your name here!_
+
+## Supporters
+
+Thank you to those who have supported Flash Chord!
+
+- Matt Godwin (donation)
diff --git a/about.php b/about.php
@@ -1,3 +1,6 @@
+<?php
+    require __DIR__ . '/vendor/autoload.php';
+?>
 <!doctype html>
 <html lang="en">
 <head>
@@ -10,13 +13,13 @@
         <h2>About</h2>
     </div>
     <div class="container">
-        <div class="row bg-light mb-2">
+        <div class="row bg-light mb-2 mt-5">
             <div class="col border-top border-bottom">
                 <h4 class="text-secondary mt-1 mb-2">Overview</h4>
             </div>
         </div>
         <p>Flash Chord is a free online tool for musicians who want to practice chords, scales, or arpeggios with an endless stream of randomized chords. Learning a song or practicing to a backing track is great, but if you really want to learn your instrument, you need to be ready for the unexpected. With Flash Chord, you can specify the speed and complexity of the chords being presented and you'll never know more than one chord in advance.</p>
-        <div class="row bg-light mb-2">
+        <div class="row bg-light mb-2 mt-5">
             <div class="col border-top border-bottom">
                 <h4 class="text-secondary mt-1 mb-2">Details</h4>
             </div>
@@ -35,7 +38,7 @@
                 You can also specify if you want additional extensions (♯5, ♭5, ♯9, ♭9, ♯11, ♭13) added to the chords by checking the <em>Add extensions</em> checkbox.<br />If you really want to kick it up a notch, check the <em>Hide next chord</em> checkbox to get the next chord without any warning!
             </li>
         </ol>
-        <div class="row bg-light mb-2">
+        <div class="row bg-light mb-2 mt-5">
             <div class="col border-top border-bottom">
                 <h4 class="text-secondary mt-1 mb-2">How you can help</h4>
             </div>
@@ -53,12 +56,32 @@
             <li><a href="https://git-scm.com/">Git</a></li>
             <li><a href="https://github.com/">GitHub</a></li>
         </ul>
-        <div class="row bg-light mb-2">
+        <div class="row bg-light mb-2 mt-5">
             <div class="col border-top border-bottom">
                 <h4 class="text-secondary mt-1 mb-2">Donate</h4>
             </div>
         </div>
         <p>If helping with code or testing isn't your thing, that's okay. You can always show your appreciate and support Flash Chord by making a donation to offset hosting and domain costs or fuel further development for bug fixes and enhancements. To learn more about making a <a href="donate.php">donation in support Flash Chord, check out the Donate page</a>.</p>
+        <div class="row bg-light mb-2 mt-5">
+            <div class="col border-top border-bottom">
+                <h4 class="text-secondary mt-1 mb-2">Changelog</h4>
+            </div>
+        </div>
+        <p>To see the changes for each version of FlashChord, you can <a href="https://github.com/KCarlile/flashchord/blob/master/CHANGELOG.md">view the changelog on GitHub</a> or you can click the "Show Changelog" button below to view the changelog on this page.</p>
+        <p>
+            <button class="btn btn-primary" type="button" data-toggle="collapse" data-target="#collapseExample" aria-expanded="false" aria-controls="collapseExample">
+                Show Changelog
+            </button>
+        </p>
+        <div class="collapse" id="collapseExample">
+            <div class="card card-body">
+                <?php
+                    $changelog = file_get_contents('CHANGELOG.md');
+                    $Parsedown = new Parsedown();
+                    print($Parsedown->text($changelog));
+                ?>
+            </div>
+        </div>
     </div>
     <footer class="pt-4 my-md-5 pt-md-5 border-top">
         <div class="container">

diff --git a/composer.json b/composer.json
@@ -0,0 +1,5 @@
+{
+    "require": {
+        "erusev/parsedown": "^1.7"
+    }
+}
diff --git a/composer.lock b/composer.lock
diff --git a/js/flashchord.js b/js/flashchord.js
@@ -17,7 +17,7 @@ $(document).ready(function() {
     // Init
     // ------------------------------------------------------------
     // first, make sure we're on the home page before doing any of the chord stuff
-    if (PAGE_NAME == "homepage") {
+    if ((typeof PAGE_NAME !== "undefined") && (PAGE_NAME == "homepage")) {   
         $chord = $next_chord ? $next_chord : getChord();
 
         $next_chord = getChord();

diff --git a/vendor/autoload.php b/vendor/autoload.php
@@ -0,0 +1,12 @@
+<?php
+
+// autoload.php @generated by Composer
+
+if (PHP_VERSION_ID < 50600) {
+    echo 'Composer 2.3.0 dropped support for autoloading on PHP <5.6 and you are running '.PHP_VERSION.', please upgrade PHP or use Composer 2.2 LTS via "composer self-update --2.2". Aborting.'.PHP_EOL;
+    exit(1);
+}
+
+require_once __DIR__ . '/composer/autoload_real.php';
+
+return ComposerAutoloaderInit89b2d0637eaca8fb337ebfbf5a730094::getLoader();