From 759c37bef95185d10ba3cbf25eff055d58dbd785 Mon Sep 17 00:00:00 2001 From: chocbic172 Date: Fri, 22 Mar 2024 21:41:25 +0000 Subject: [PATCH] Update README for final submission --- README.md | 17 ++++++++++++++--- checklist.md | 2 +- changelog.txt => docs/changelog.txt | 0 3 files changed, 15 insertions(+), 4 deletions(-) rename changelog.txt => docs/changelog.txt (100%) diff --git a/README.md b/README.md index 444657d..c732bbf 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,21 @@ To test the website, the following example credentials can be used:\ capabilities. In a real deployment it would be beneficial to enable this. - Prepared SQL statements are used to generate all user related INSERTs. This prevents SQL injection attacks. We also filter out HTML/XSS attacks by escaping special HTML characters. +- All database functions were abtracted to `utils/database.php`. This significatly simplified + the creation new pages as the database functionality did not have to be ported. I considered + using the [ORM](https://en.wikipedia.org/wiki/Object%E2%80%93relational_mapping) paradigm, but + decided against it due to time constraints. This seemed like a good compromise between the + developer experience of ORM, and the simplicity of direct implementation. +- Some common frontend UI components (navbar, footer) were saved to the `components` folder. They + are then imported in each page, meaning an update to the component affected the design sitewide. ## Wider Reading -W3, MDN, PHP Docs +The main resources used during development were: +- [The official PHP documentation](https://www.php.net/docs.php) - Used extensively in researching and using the inbuilt language features of PHP. +- [W3 School](https://www.w3schools.com/php/default.asp) - Used for researching features of SQL, and for some more advanced use cases of PHP classes. +- [MDN Web Docs](https://developer.mozilla.org/en-US/) - Used for researching HTML accessibility features, and for the javascript implementation of the "Add To Cart" button. ## Acessibility and Usability -All text elements were sufficiently visible against their backgrounds.\ -Aria-labels have been used. +- Images all use the `alt` attribute to provide context for screenreaders. +- Form fields are sensibly named and labelled for visually impared website users. +- All text elements were sufficiently visible against their backgrounds. diff --git a/checklist.md b/checklist.md index 290e689..05964d0 100644 --- a/checklist.md +++ b/checklist.md @@ -24,7 +24,7 @@ # Semester 2 - [ ] Lab Demo -- [ ] README follows requirements +- [x] README follows requirements - [x] All pages defined with `.php` - [x] Communication with MySQL Database - [x] Live offers presented diff --git a/changelog.txt b/docs/changelog.txt similarity index 100% rename from changelog.txt rename to docs/changelog.txt