docs: fix types in docs and comments

Author: YasharF

PROD_CHECKLIST.md

@@ -1,22 +1,22 @@
 If you are done with your hackathon and thinking about launching your project into production, or if you are just using this boilerplate to start your soon to be in production application, this document is a checklist to help you get your application production ready.
 
-- Remove Unused code and configs
-- Add a proxy such as Cloudflare in front of your production deployment. Adjust numberOfProxies logic in app.js if needed.
+- Remove unused code and configs
+- Add a proxy such as Cloudflare in front of your production deployment. Adjust the numberOfProxies logic in app.js if needed
 - Update the session cookie configs with sameSite attribute, domain, and path
 - Add Terms of Service and Privacy Policy
-- Update `License.md` and the relevant license field in package.json if applicable - See [npm's doc](https://docs.npmjs.com/files/package.json#license).
+- Update `LICENSE.md` and the relevant license field in package.json if applicable - See [npm's doc](https://docs.npmjs.com/files/package.json#license).
 - Add [sitemap.xml](https://en.wikipedia.org/wiki/Sitemaps) and [robots.txt](https://moz.com/learn/seo/robotstxt)
 - Update Google Analytics ID
 - Add Facebook App/Pixel ID
 - Add Winston Logging, and replace console.log statements with Winston; have a process for monitoring errors to identify bugs or other issues after launch.
 - SEO and Social Media Improvements
 - Create a deployment pipeline with a pre-prod/integration test stage.
 - (optional) Add email verification _Some experimental data has shown that bogus email addresses are not a significant problem in many cases_
-- (optional) Add a filter with [disposable-email-domains](https://www.npmjs.com/package/disposable-email-domains). _Some experimental data has shown that use of disposable emails is typically rare, and in many cases it might not be worth add the filter._
+- (optional) Add a filter with [disposable-email-domains](https://www.npmjs.com/package/disposable-email-domains). _Some experimental data has shown that use of disposable emails is typically rare, and in many cases it might not be worth adding the filter._
 
 ### Remove unused code and configs
 
-The following is a list of various codes that you may not potential be using and you could remove depending on your application:
+The following is a list of various code that you may not potentially be using and you could remove depending on your application:
 
 - Unused keys from .env file
 - /controllers/api.js entirely
@@ -27,7 +27,7 @@ The following is a list of various codes that you may not potential be using and
   - Openshift env references
   - csrf check exception for /api/upload
   - All API example routes
-  - OAuth routes for authentications that you are not using (i.e.Github, LinkedIn, etc based on your app)
+  - OAuth routes for authentications that you are not using (i.e. GitHub, LinkedIn, etc. based on your app)
   - All OAuth authorization routes
 - passport.js all references and functions related to:
   - Github, LinkedIn, OpenID, OAuth, OAuth2
@@ -38,11 +38,11 @@ The following is a list of various codes that you may not potential be using and
 - /test
   - Replace E2E and API example tests with new tests for your application
 - views/account/login.pug
-  - Some or all of the last form-group set which are the social login choices
+  - Some or all of the last form-group set, which are the social login choices
 - views/account/profile.pug
-  - Link/unlink buttons for Github, LinkedIn, steam
-- Removed readme, changelog, this guide, docker related files if not using them
-- Create a domain whitelist for your app in Here's developer portal if you are using the Here's map API.
+  - Link/unlink buttons for GitHub, LinkedIn, Steam
+- Remove README, changelog, this guide, Docker-related files if not using them
+- Create a domain whitelist for your app in Here's developer portal if you are using the HERE Maps API.
 - Add unit tests so you can test and incorporate dependency and upstream updates with less effort. GPT tools may create some good unit tests with very low effort.
 
 ### Search Engine Optimization (SEO)
@@ -62,8 +62,3 @@ Note that SEO only applies to the pages that will be publicly visible with no au
   ```
   <meta name="Description" content="Description about the page.">
   ```
-
-- Add the Google Plus page as the publisher of the website.
-  ```
-  <link rel=”publisher” href=”https://plus.google.com/+your_business_google_plus_id”>
-  ```

README.md

@@ -639,7 +639,7 @@ Required to run the project before your modifications
 | pdfjs-dist                    | PDF parser                                                            |
 | pug                           | Template engine for Express.                                          |
 | sass                          | Sass compiler to generate CSS with superpowers.                       |
-| stripe                        | Offical Stripe API library.                                           |
+| stripe                        | Official Stripe API library.                                          |
 | twilio                        | Twilio API library.                                                   |
 | twitch-passport               | Sign-in with Twitch plugin.                                           |
 | validator                     | A library of string validators and sanitizers.                        |

SECURITY.md

@@ -2,8 +2,6 @@
 
 ## Supported Versions
 
-Use this section to tell people about which versions of your project are currently being supported with security updates.
-
 | Version | Supported          |
 | ------- | ------------------ |
 | latest  | :white_check_mark: |
@@ -14,12 +12,12 @@ Use this section to tell people about which versions of your project are current
 
 PRIOR TO SUBMITTING SECURITY CONCERNS/REPORTS:
 
-1. Research Wikipedia and other sources about hackathons to get more familiar with the potential uses of this project, the intended settings, and usage environments.
-2. Read README.MD entirely, including the intro paragraph and steps for Obtaining API Keys which includes replacing the .env values. The provided values in the .env file are placeholders, not a batch of keys exposed thru GitHub.
-3. Read prod-checklist.md. Hackathon projects are not production projects, and this checklist is to help users with their next steps to move from a prototype state to a production state.
+1. Research Wikipedia and other sources about hackathons to become more familiar with the potential uses of this project, the intended settings, and usage environments.
+2. Read README.md entirely, including the introduction and the steps for obtaining API keys, which includes replacing the .env values. The provided values in the .env file are placeholders, not a batch of keys exposed through GitHub.
+3. Read PROD_CHECKLIST.md. Hackathon projects are not production projects, and this checklist is to help users with their next steps to move from a prototype state to a production state.
 
 SUBMITTING SECURITY CONCERNS/REPORTS:
 
 1. Complete the above steps 1 to 3.
 2. If you still believe you have identified an issue, please submit it as a GitHub Issue at https://github.com/sahat/hackathon-starter/issues with the relevant information for discussion and clarification.
-   Submissions requiring registration with 3rd party websites will be marked/reported as spam.
+   Submissions requiring registration with third-party websites will be marked/reported as spam.

controllers/ai.js

@@ -620,7 +620,7 @@ Provide the output in this JSON structure:
 }
 Replace <selected_department> with the name of the most relevant department from the list above. If the inquiry spans multiple categories, choose the department that is most likely to address the customer's issue promptly and effectively.`;
 
-// Image Uploade middleware for Camera uploads
+// Image upload middleware for camera uploads
 const createImageUploader = () => {
   const memoryStorage = multer.memoryStorage();
   return multer({

controllers/user.js

@@ -138,9 +138,9 @@ exports.getSignup = (req, res) => {
 };
 
 /**
- * Helper to send passwordless login link if a user is trying to create an account
+ * Helper to send a passwordless login link if a user is trying to create an account
  * but we already have an account for that email address.
- * This process with ambigious flash messages is a part of the security measure to
+ * This process with ambiguous flash messages is part of the security measures to
  * mitigate account enumeration attacks.
  */
 async function sendPasswordlessLoginLinkIfUserExists(user, req) {
@@ -177,7 +177,7 @@ Thank you!\n`,
 }
 
 /**
- * Helper to send passwordless signup link for new users.
+ * Helper to send a passwordless signup link for new users.
  */
 async function sendPasswordlessSignupLink(user, req) {
   const token = await User.generateToken();
@@ -319,8 +319,8 @@ exports.postUpdateProfile = async (req, res, next) => {
     } else {
       console.log('Error updating profile', err);
     }
-    // Generic error message for the user. Do not reveal the cause of the error tsuch as
-    // the new email being in the system to the user to avoid enumeration vulenrability.
+    // Generic error message for the user. Do not reveal the cause of the error, such as
+    // the new email being in the system, to the user to avoid enumeration vulnerability.
     req.flash('errors', {
       msg: "We encountered an issue updating your email address. If you suspect you have duplicate accounts, please log in with the other email address you've used or contact support for assistance. You can delete duplicate accounts from your account settings.",
     });

test/TESTING.md

@@ -80,10 +80,10 @@ Use one script with project selection:
 ```bash
 npm run test:e2e:live                                   # All E2E tests with live API calls
 npm run test:e2e:replay                                 # All E2E tests with previously recorded API responses
-npm run test:custom -- --project=chromium-record        # E2E with recording API calls (record fixtures)
-npm run test:custom -- --project=chromium-nokey-live    # Only E2E tests that don't require API keys (live)
-npm run test:custom -- --project=chromium-nokey-replay  # Only E2E tests that don't require API keys (replay fixtures)
-npm run test:custom -- --project=chromium-nokey-record  # Only E2E tests that don't require API keys (record fixtures)
+npm run test:e2e:custom -- --project=chromium-record        # E2E with recording API calls (record fixtures)
+npm run test:e2e:custom -- --project=chromium-nokey-live    # Only E2E tests that don't require API keys (live)
+npm run test:e2e:custom -- --project=chromium-nokey-replay  # Only E2E tests that don't require API keys (replay fixtures)
+npm run test:e2e:custom -- --project=chromium-nokey-record  # Only E2E tests that don't require API keys (record fixtures)
 ```
 
 ### Run a Single E2E Test File