Refactor JavaScript in the application

[kallewesterling]

Description

Currently, all the JavaScript in the Seshat project is spread across multiple .js files and some embedded JavaScript within the HTML. This issue aims to refactor the JavaScript code, ensure it is well-documented, and potentially implement JavaScript testing.

Objectives

• Consolidate and organise JavaScript code into appropriate .js files.
• Remove embedded JavaScript from HTML files and include them in the consolidated .js files.
• Add comprehensive documentation to all JavaScript functions and modules, see Add tests add docstrings for JavaScript map functions edwardchalstrey1/seshat#119
• Implement JavaScript testing to ensure the refactored code is functional and maintainable, see Add tests add docstrings for JavaScript map functions edwardchalstrey1/seshat#119

Tasks

• Consolidation of all code:
  • Identify and list all JavaScript code currently embedded in HTML files.
  • Create or update .js files to include the identified JavaScript code.
  • Ensure all HTML files are updated to reference the external .js files instead of embedded scripts.
• Refactoring:
  • Refactor the consolidated JavaScript code to improve readability, maintainability, and performance.
  • Use consistent coding standards and practices throughout the codebase.
  • Ensure proper modularisation of the JavaScript code.
• Documentation:
  • Add detailed comments and documentation to all JavaScript functions and modules.
  • Include information about the purpose, parameters, return values, and any important notes for each function.
  • Ensure documentation is clear and easy to understand.
• Testing:
  • Identify and set up a suitable JavaScript testing framework (e.g., Jest, Mocha, Jasmine -- see list here).
  • Write unit tests for all critical functions and modules to verify their behaviour.
  • Integrate tests into the project's CI/CD pipeline to ensure ongoing code quality.

Definition of Done

• All JavaScript code is consolidated into appropriate .js files.
• No JavaScript is embedded directly within HTML files.
• The code is fully documented, following the project's documentation standards.
• Unit tests are implemented, and all tests pass successfully.
• The refactored code is reviewed, merged into the main branch, and deployed to the QA environment.
• The changes are demonstrated to the team and accepted by the product owner.

[edwardchalstrey1]

@kallewesterling if you have worked on this want to open a draft PR?