Update website sections of readme

README.md

@@ -17,11 +17,9 @@ The Arduino folder holds the two Arduino sketches, one for each Arduino (Arduino
 
 Other folders in the Pi directory act as logical separation for scripts within the main Python workflow.
 
-## Web ##
-This folder holds the logic for the website.
+## Site ##
 
-
-## Database ##
+This folder holds the logic for the website. This consists of TypeScript files for pages and API endpoints of the site, alongside the backend functionality for handling user requests and sessions. This is run through the npm package manager, through command `npm run dev`. A sub-folder in this folder holds the logic for interacting with the database, making SQL queries to an externally hosted Postgres database. See the README.md in the Site sub-folder for more granular information on site folder directories.
 
 # Pi Setup Instructions #
 ### Prerequisites ###
@@ -86,6 +84,21 @@ This folder holds the logic for the website.
 
 
 # Website Setup Instructions #
+
+Navigate to the `\site` directory in your shell of choice, then run `npm install` to 
+install all required packages for the site. This may take a while. 
+
+Add a .env file to the directory, consisting of the following. 
+```
+SESSION_SECRET=secretword
+DATABASE_URL=postgres://neondb_owner:npg_4y5eOQkbnVsg@ep-dry-tree-abeicwnr-pooler.eu-west-2.aws.neon.tech/neondb?sslmode=require
+```
+
+The site is now ready to run locally, and will connect to the Postgres database
+without issue.
+
+Run `npm run dev` then navigate to http://localhost:3000 to view the site. 
+
 # Running the Project #
 - On the Pi, run `~/cm2305/pi/start.sh`. On running, this should start Node-Red with required libraries.
 # Third-Party Software and Frameworks #
@@ -121,7 +134,44 @@ This folder holds the logic for the website.
 - **RPi.GPIO 0.7.1**
   - Purpose: Python library for controlling GPIO pins on the Raspberry Pi.
   - Documentation: [https://pypi.org/project/RPi.GPIO/](https://pypi.org/project/RPi.GPIO/)
+ 
+- **HeroUI 2.7**
+  - Purpose: Used for UI components to make the site look pretty.  
+  - Documentation: [HeroUI v2.7](https://www.heroui.com/) 
+
+- **BCrypt for Node JS 5.1.1**
+  - Purpose: Used to hash passwords for secure storage.
+  - Documentation: - [BCrypt for Node JS - 5.1.1](https://www.npmjs.com/package/bcrypt)
+
+- **D3 7.9**
+  - Purpose: Displaying the dashboard bar chart. 
+  - Documentation: [d3  - 7.9](https://www.npmjs.com/package/d3)
 
+- **Next JS 15**
+  - Purpose: For the website's server model, building on React
+  - Documentation: [Next JS 15](https://nextjs.org)
+
+- **React 18**
+  - Purpose: For the site's frontend matter
+  - Documentation: [React 18](https://react.dev)
+
+- **Zod 3.24**
+  - Purpose: Used to validate the Signup form fields
+  - Documentation: [Zod 3.24](https://www.npmjs.com/package/zod)
+
+- **Postgres 3.4 for Node**
+  - Purpose: Used to query the Postgres database
+  - Documentation: [Postgres 3.4 for Node](https://www.npmjs.com/package/postgres)
+
+Used for Hosting, not in repo:
+
+- **Vercel**
+  - Purpose: For the site, allowing for constant uptime
+  - Documentation: [Vercel](https://vercel.com)
+
+- **Neon**
+  - Purpose: For hosting the Postgres database with constant uptime.
+  - Documentation: [Neon](https://neon.tech/)
 
 # Code Documentation #
 Code is primarily documented via inline annotations.
@@ -132,6 +182,4 @@ The Node-Red flow features two 'comment' nodes that act as pointers for develope
 It's important that the two Arduinos are correctly configured with the right components, sketch, and serial port. If, on monitoring in Node-Red, the Arduinos have swapped functions, it's most likely the serial ports are incorrect. It should be Arduino 0 = ACM0 and Arduino 1 = ACM1. The easiest way to correct this is by unplugging both Arduinos and replugging them, with Arduino 0 being plugged in first.
 
 #### Stranded in Middle of Node-Red Flow ####
-If a component is misconfigured and interferes at a point in time after passing the Lock node but not the Unlock node, the system will never reset and won't take accept new inputs. If this happens, stop Node-Red with ctrl+c and re-enter `~/cm2305/pi/start.sh`.
-
-## Website ##
\ No newline at end of file
+If a component is misconfigured and interferes at a point in time after passing the Lock node but not the Unlock node, the system will never reset and won't take accept new inputs. If this happens, stop Node-Red with ctrl+c and re-enter `~/cm2305/pi/start.sh`.
\ No newline at end of file