aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKaran Jayachandra <mail@karanjayachandra.com>2024-11-15 17:18:00 +0100
committerKaran Jayachandra <mail@karanjayachandra.com>2024-11-15 17:18:00 +0100
commit7b7af30b84ec430a6fccfe4d81df0119c773665c (patch)
treebe0a95f185e6c2b2168bf286a0aa3e25fbacb171 /README.md
parent9c8e387d441359bd079d29e92863ce164a8f801d (diff)
Changed the code base with an ADR
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index 42ca714..93f656e 100644
--- a/README.md
+++ b/README.md
@@ -74,8 +74,10 @@ pythonw -m flask run -p <port-number>
Create a task using Task Scheduler to run this script on start up.
-## Background / Motivation
+## Architectural Design Record
-This part of the README focuses on the motivation of why this application was built and contains no technical value. Please read on in case you want to know more about the technological choices made.
+This part of the README focuses on the motivation of why this application was built and contains background information. Please read on in case you want to know more about the technological choices made.
-> I am part of a badminton club where an old Microsoft Access application was being used to run the games played every week. The application started crashing after a good run of a few years and also lacked a few badly needed features. Instead of fixing the old application, I took it upon myself to create something using tools that are more suited for such an application. I wanted to prioritize delivery speed for performance and hence choose Python. More over, the sheer number of Python programmers allows for the application to be easily maintained by others. I myself have no idea how Microsoft Access works. Since it was quite a small application, I went with Flask as it was more than enough for the features that I needed instead of Django. I have a background in electrical engineering and having never made frontends before, went with the simplest option for the user interface after a bit of research. HTMX required no need of me writing JavaScript and was by far the most appealing option. The website needed some basic styling and after looking at a few CSS frameworks, I settled with Bulma. It gives me everything I need. The application is scheduled to be deployed.
+- Python was choose to prioritize delivery speed not for performance. More over, the sheer number of Python programmers allows for the application to be easily maintained by others.
+- Flask was choosed as it more than enough for the features that I needed instead of Django. The application is to run locally on a laptop and doesn't really need to have complicated features.
+- Due to a lack of frontend developers, the simplest UI stack was choosen. HTMX requires no need of JavaScript and was a natural choice. The website needed some basic styling and after looking at a few CSS frameworks, Bulma provided most of the styling. A toasting library, "Notyf" was also used for simple notifications to be sent via some custom javascript code for a simple timer.