Add initial project files and configuration

.gitattributes

@@ -0,0 +1,6 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Using Microsoft Word with git
+# https://github.com/marcocrowe/track-ms-word-docx-with-github
+*.docx diff=pandoc

.gitignore

@@ -0,0 +1,122 @@
+# Created by https://www.toptal.com/developers/gitignore/api/linux,macos,windows,libreoffice,microsoftoffice,visualstudiocode
+# Edit at https://www.toptal.com/developers/gitignore?templates=linux,macos,windows,libreoffice,microsoftoffice,visualstudiocode
+
+### LibreOffice ###
+# LibreOffice locks
+.~lock.*#
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### MicrosoftOffice ###
+*.tmp
+
+# Word temporary
+~$*.doc*
+
+# Word Auto Backup File
+Backup of *.doc*
+
+# Excel temporary
+~$*.xls*
+
+# Excel Backup File
+*.xlk
+
+# PowerPoint temporary
+~$*.ppt*
+
+# Visio autosave temporary files
+*.~vsd*
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.toptal.com/developers/gitignore/api/linux,macos,windows,libreoffice,microsoftoffice,visualstudiocode

.vscode/extensions.json

@@ -0,0 +1,29 @@
+{
+	"recommendations": [
+		"alanwalk.markdown-navigation",
+		"davidanson.vscode-markdownlint",
+		"streetsidesoftware.code-spell-checker",
+		"yzhang.markdown-all-in-one",
+		"maptz.camelcasenavigation",
+		"wmaurer.change-case",
+		"bierner.markdown-footnotes",
+		"mdickin.markdown-shortcuts",
+		"darkriszty.markdown-table-prettify",
+		"cweijan.vscode-office",
+		"wraith13.open-in-github-desktop",
+		"mechatroner.rainbow-csv",
+		"gruntfuggly.todo-tree",
+		"vscode-icons-team.vscode-icons",
+        "jannisx11.batch-rename-extension",
+        "shinotatwu-ds.file-tree-generator",
+        "eamodio.gitlens",
+        "george-alisson.html-preview-vscode",
+        "shd101wyy.markdown-preview-enhanced",
+        "bierner.markdown-mermaid",
+        "tomoyukim.vscode-mermaid-editor",
+        "gruntfuggly.mermaid-export",
+        "bpruitt-goddard.mermaid-markdown-syntax-highlighting",
+        "jackiotyu.size-tree",
+        "jebbs.plantuml",
+	]
+}

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+	"cSpell.words": [
+		"Atoz",
+		"Colab",
+		"Crowe",
+		"pandoc"
+	]
+}

LICENSE

@@ -0,0 +1,14 @@
+Copyright [Year] [Student's Name or Project Owner's Name]
+
+All rights reserved.
+
+This project and its content are the sole property of [Student's Name or Project Owner's Name]. Unauthorized copying, distribution, modification, or any use of the code in any form, by any means, is strictly prohibited without prior written permission.
+
+You may not:
+- Use, distribute, or share this project in any form.
+- Modify or adapt this code in any way.
+- Copy or reproduce any part of this project.
+
+The owner reserves the right to deny the use of this code under any circumstance.
+
+For any questions regarding the use of this code or to obtain permission, please contact the project owner at [contact information].

docs/slides.html

@@ -0,0 +1,83 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <title>Final Year Project Guidance</title>
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+  <!-- Include Reveal.js -->
+  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/reveal.js/4.4.0/reset.css">
+  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/reveal.js/4.4.0/reveal.css">
+  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/reveal.js/4.4.0/theme/white.css">
+</head>
+<body>
+
+  <div class="reveal">
+    <div class="slides">
+
+      <!-- Slide 1 -->
+      <section>
+        <h2>Welcome!</h2>
+        <p>I'm <strong>Mark Crowe</strong></p>
+        <p>Your tutor in Software Development and all things Computers!</p>
+      </section>
+
+      <!-- Slide 2 -->
+      <section>
+        <h2>Join GitHub.com</h2>
+        <p>Why should you join?</p>
+        <ul>
+          <li>Collaborate with developers</li>
+          <li>Showcase your projects</li>
+          <li>Track your progress with version control</li>
+        </ul>
+      </section>
+
+      <!-- Slide 3 -->
+      <section>
+        <h2>Recommended Technologies</h2>
+        <p>For web projects, consider using:</p>
+        <ul>
+          <li><strong>Python</strong> and <strong>Django</strong> for websites</li>
+          <li><strong>C#</strong> and <strong>ASP.NET</strong> for enterprise-level applications</li>
+        </ul>
+      </section>
+
+      <!-- Slide 4 -->
+      <section>
+        <h2>Artificial Intelligence</h2>
+        <p>Consider exploring AI with:</p>
+        <ul>
+          <li><strong>Python</strong> for machine learning and AI applications</li>
+          <li><strong>Jupyter Notebooks</strong> for interactive development and data science</li>
+        </ul>
+      </section>
+
+      <!-- Slide 5 -->
+      <section>
+        <h2>Make Your Own Reveal.js Presentation</h2>
+        <p>Want to create your own presentation?</p>
+        <ul>
+          <li>Visit <a href="https://revealjs.com" target="_blank" rel="noopener">Reveal.js Website</a></li>
+          <li>Check out the <a href="https://revealjs.com/docs/" target="_blank" rel="noopener">Reveal.js Documentation</a></li>
+          <li>Perfect for creating beautiful, interactive slides</li>
+        </ul>
+      </section>
+
+      <!-- Slide 6 -->
+      <section>
+        <h2>Thank You!</h2>
+        <p>Thanks for coming, and good luck with your final year projects!</p>
+      </section>
+
+    </div>
+  </div>
+
+  <!-- Include Reveal.js script -->
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/reveal.js/4.4.0/reveal.js"></script>
+  <script>
+    Reveal.initialize();
+  </script>
+
+</body>
+</html>

docs/tus-thesis-checklist.md

@@ -0,0 +1,82 @@
+
+# TUS Thesis Checklist and Document Style
+
+A checklist for the [TUS](https://www.tus.ie/ "TUS") Thesis document style. This document is a summary of the TUS - FYP Student Guide V3.4 (2023/24).  Please check with your supervisor for the most up-to-date version of this document. A Snapshot of the document used for this guide is available in the repository at :
+[FYP Student Handbook 2023-24](it-fyp-student-guidelines-v3.4-2023.pdf "FYP Student Handbook 2023-24")
+
+- [x] Open this document.
+- [ ] Complete the checklist.
+
+Suggested Layout
+
+1. Title Page
+2. Ethical Declaration
+3. Acknowledgements
+4. Abstract
+5. Table of Contents
+6. Lists of Figures, Tables, and Abbreviations
+7. Introduction
+8. Methodology (Analysis and Design/Implementation)
+9. Results (Implementation/Testing/Findings)
+10. Discussion
+11. Conclusions
+12. Reference List/Bibliography
+13. Appendices (supporting materials)
+
+## Title Page
+
+- [ ] Title / One line Unique Selling Point (UPS)
+- [ ] Name of Author(s)
+- [ ] Student id
+- [ ] Course Name
+- [ ] Supervisor
+- [ ] College Logo
+- [ ] Date: Year
+
+## References
+
+Use harvard referencing style
+
+## Abstract
+
+Limited to 300 words
+
+## Document Formats
+
+### Paragraphs/Text
+
+- [ ] Recommended typeface: Times New Roman, 12pt, and color black.
+- [ ] 1.5 Line Spacing
+- [ ] Paragraphs Spacing 0 pt before, 8 pt after
+- [ ] Text should be set to fully justified in the Normal Style
+- [ ] Code in your document may be presented with an alternative font and size, such as Consolas 9.5 or 10.
+
+### Headings
+
+- [ ] Recommend default spacing for your headings.
+- [ ] Heading 1 starts on a new page
+- [ ] Headings Bold, multi-level list
+- [ ] Appendices should have their own Heading numbering (start at 1) and be numbered separately from each other.
+
+### Pages
+
+- [ ] Margins 4cm left, 2cm right, 2.5cm top, 2.5cm bottom
+- [ ] Page numbers should be inserted in the footer of the page and aligned to the right
+- [ ] You are required to use Roman Numerals for all of the pages before the Introduction
+  - [ ] Text for anything other than Body text should be left-aligned, including headings, table contents, and Reference lists.
+- [ ] Figures should always appear after the end of the paragraph in which they are first referenced, or as close as possible to that point to avoid having gaps between areas of text.
+- [ ] Do not interrupt a paragraph or a sentence to insert a figure or table.
+- [ ] Do not precede figures and tables with Chapter numbers (e.g., 3.1, 3.2, 4.1, etc.). Figures should begin with Figure 1 and tables with Table 1.
+- [ ] A List of Figures and a List of Tables must be inserted in your document just after the Tables of Contents (see Section 5).
+
+### The Binder Cover
+
+- [ ]  The title appears at the top in at least 24pt font
+- [ ]  Your full name (first name and surname) appears under this, also centred. This will be in a smaller point
+- [ ]  The award appears underneath this (e.g., BSc. (Honours) in Computer Networks and Systems Management). The year of submission appears underneath this (e.g., 2019). You may place the TUS logo on the cover page if you wish, but you must use a high-quality version if you do.
+- [ ]  The spine of the document must also include some information so that it can be identifiable on a library shelf. You need to include your name, the year, and the award, which can be abbreviated if it is too long to fit (e.g., BSc (Hons) SD).
+- [ ]  The font used for the cover page should be selected to look good. The font used in the sample cover page is Georgia.
+
+## Printing
+
+- [ ] The document should be printed on one side of the paper only.

readme.md

@@ -5,13 +5,23 @@ By Mark Crowe
 
 > "A library serves no purpose unless someone is using it." – Atoz, 2269
 
-## Requirements
+## Tools Used/Recommended IDEs
 
-- [Git](https://git-scm.com/)
+- [GitHub Desktop](https://desktop.github.com/ "GitHub Desktop")
+- [VS Code](https://code.visualstudio.com/ "VS Code")
+- [Git](https://git-scm.com/ "Git")
+- [Pandoc](https://pandoc.org/ "Pandoc")
+- [Microsoft Word](https://www.microsoft.com/en-ie/microsoft-365/word "Microsoft Word")
 
-## Tools Used/Recommended IDEs
+### Online Tools
+
+- [GitHub](https://github.com "GitHub")
+- [Microsoft Office Online](https://www.office.com/ "Microsoft Office Online")
+
+### Diagrams
 
-- [VS Code](https://code.visualstudio.com/)
+- [Mermaid Live Editor](https://mermaid-js.github.io/mermaid-live-editor/)
+- [PlantUML](https://plantuml.com/)
 
 ## Directory Structure
 
@@ -28,4 +38,4 @@ By Mark Crowe
 ---
 **Template footnote:**
 
-This project started from the template <https://github.com/markcrowe-com/data-analytics-project-template>. Permission is granted to reproduce for personal and educational use only. Commercial copying, hiring, lending is prohibited. In all cases this notice must remain intact. Template Author [Mark Crowe](https://github.com/markcrowe-com/) Copyright &copy; 2021, All rights reserved.
+This project started from the template <https://github.com/marcocrowe/final-year-project-fyp-thesis-template>. Permission is granted to reproduce for personal and educational use only. Commercial copying, hiring, lending is prohibited. In all cases this notice must remain intact. Template Author [Mark Crowe](https://github.com/marcocrowe/) Copyright &copy; 2021, All rights reserved.