From 0d58ec9d9b1c62b7cb3d575ddbde8a423cf4c755 Mon Sep 17 00:00:00 2001 From: Karan Jayachandra Date: Tue, 27 Jan 2026 12:48:09 +0100 Subject: Edit README.md --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 98662c4..99c4c19 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ What this application ***IS***: What this application ***IS NOT***: - Secure: The data is available for anyone to observe via the browser console -- Performant: Works with a small number of named players (<3 MB) +- Performant: Works with a small number of named players (<3MB) ## Usage @@ -62,3 +62,15 @@ npm install ``` To run a development server run `npm run dev` or run `npm run build` to create a optimized bundle of static content. I choose to serve this content via GitLab pages but you could choose to do so in any other server. + +## Architectural Design Record + +Key Learnings: + +- The choice of language is tightly coupled to application complexity requirements: + - [Flask](https://flask.palletsprojects.com/en/stable/) or [Dash](https://dash.plotly.com/tutorial) applications are easy to develop but hard to deploy. + - JavaScript is a superb language for creating shareable tools for non-technical people. +- Front end work and back end work are equally important in the success of an application. +- Vanilla JavaScript is enough for most simple applications; complex applications might benefit from [state](https://refactoring.guru/design-patterns/state). + +At [my badminton club](https://www.bctsf.nl/) we run a hustle system to create matches of four players from a pool of players currently at the club. This application aimed to solve this problem. \ No newline at end of file -- cgit v1.3.1