Update README for final submission

chocbic172 · Mar 22, 2024 · 759c37b · 759c37b
1 parent d444b11
commit 759c37b
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 4 deletions.
diff --git 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
@@ -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 → docs/changelog.txt b/changelog.txt → docs/changelog.txt