IDE Checks

LICENSE

@@ -12,7 +12,7 @@ modification, are permitted provided that the following conditions are met:
    this list of conditions and the following disclaimer in the documentation
    and/or other materials provided with the distribution.
 
-3. Neither the name of the copyright holder nor the names of its
+3. Neither the name of the copyright holder nor the names of it's
    contributors may be used to endorse or promote products derived from
    this software without specific prior written permission.
 

README.md

@@ -1,3 +1,4 @@
+<!--suppress ALL -->
 <br/>
 <p align="center">
   <a href="https://github.com/maxtyson123/13_DGT_WEBSITE">
@@ -41,7 +42,7 @@
 
 ![Screen Shot](doc/screenshots/about.png)
 
-This project is built on top of next js and a SQL database to create a website that informs users about various New Zealand plants and their uses. The website aims to display this information in a interesting, entertaining and interactive way with the site being accessible to a wide range of users on mobile or PC. The plants are stored in a SQL database which the website uses to dynamically generate the contents for the pages from, with it heavily relying on the ID of the plant to do most things. Additonally,  a API is provided to interact with the database connected to the site allowing for the user to search for a plant or download a plant's information. Parts of the API that modify data are restricted behind user authentication, either in the form of an API key or a whitelisted email in the auth table of the database.
+This project is built on top of Next.js and a SQL database to create a website that informs users about various New Zealand plants and their uses. The website aims to display this information in an interesting, entertaining and interactive way with the site being accessible to a wide range of users on mobile or PC. The plants are stored in a SQL database which the website uses to dynamically generate the contents for the pages from, with it heavily relying on the ID of the plant to do most things. Additionally,  an API is provided to interact with the database connected to the site allowing for the user to search for a plant or download a plant's information. Parts of the API that modify data are restricted behind user authentication, either in the form of an API key or a whitelisted email in the auth table of the database.
 
 ## Built With
 
@@ -58,7 +59,7 @@ To get a local copy up and running follow these simple steps.
 
 ### Prerequisites
 
-The website requires npm and node js
+The website requires npm and Node.js
 
 * [node.js](https://nodejs.org/en)
 * [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
@@ -75,24 +76,24 @@ git clone https://github.com/maxtyson123/13_DGT_WEBSITE.git
 npm install
 ```
 * Copy the '.env.example' into a new file '.env.local'
-2. Database Setup (Pick one and edit constants.ts to select which one is being used)
+1. Database Setup (Pick one and edit constants.ts to select which one is being used)
 
 2. A) Postgres:
 * Setup a Postgres server [PostgreSQL](https://www.postgresql.org/)
 * Copy the config into .env.local
 * Run the SQL file [create_tables](server/postgres_sql/create_tables.sql)
 
-2. B) MySQL:
+1. B) MySQL:
 * Setup a MySQL server [MySQL](https://www.mysql.com/)
 * Copy the config into .env.local
 * Run the SQL file [create_tables](server/my_sql/create_tables.sql)
 
-3. FTP Setup:
+1. FTP Setup:
 * Download [FileZilla](https://filezilla-project.org/download.php) or any other FTP provider
 * Copy the config into .env.local
 
-4. Github Setup:
-* Go to [Github Apps](https://github.com/settings/apps) and press 'New App'
+1. GitHub Setup:
+* Go to [GitHub Apps](https://github.com/settings/apps) and press 'New App'
 * Set the GitHub App name to Rongoā
 * Set the homepage and callback URLs to your site, e.g.
 ```sh
@@ -101,9 +102,9 @@ http://localhost:3000/api/auth/callback/github
 * Under account permissions set Email addresses to read only
 * Once completed creation, create a new client secret
 * Copy the config into .env.local
-5. Other OAuth Setup:
-* Follow NextAuth.js's [documentation](https://next-auth.js.org/configuration/providers/oauth) to setup other OAuth providers
-6. Run the site
+1. Other OAuth Setup:
+* Follow NextAuth.js's [documentation](https://next-auth.js.org/configuration/providers/oauth) to set up other OAuth providers
+1. Run the site
 ```sh
  cd website
  npm run dev
@@ -126,7 +127,7 @@ To add an api key, go to the user profile page and press the generate api key bu
 Go to the [/plants/create](https://13-dgt-website.vercel.app/plants/create) page and enter the information for the plant. Once you are finished, press the upload button, or if you wish to continue creating the plant later, press generate JSON (note: images and attachments will have to be selected again).
 
 ##### Edit Plants
-Go to the [/plants/create?id={id_of_plant}](https://13-dgt-website.vercel.app/plants/create) page and edit the information for the plant. Once you are finished, press the upload button and it will modify that plant.
+Go to the [/plants/create?id={id_of_plant}](https://13-dgt-website.vercel.app/plants/create) page and edit the information for the plant. Once you are finished, press the upload button, and it will modify that plant.
 
 
 _For more examples, please refer to the [Documentation](https://maxtyson123.github.io/13_DGT_WEBSITE)_
@@ -137,7 +138,7 @@ See the [open issues](https://github.com/maxtyson123/13_DGT_WEBSITE/issues) for
 
 ## Contributing
 
-Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+Contributions are what make the open source community such an amazing place to be learned, inspire, and create. Any contributions you make are **greatly appreciated**.
 * If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/maxtyson123/13_DGT_WEBSITE/issues/new) to discuss it, or directly create a pull request after you edit the *README.md* file with necessary changes.
 * Please make sure you check your spelling and grammar.
 * Create individual PR for each suggestion.

website/src/components/dropdown_section.tsx

@@ -1,4 +1,4 @@
-import {useState} from "react";
+import React, {useState} from "react";
 import styles from "@/styles/components/dropdown_section.module.css";
 
 interface DropdownSectionProps {

website/src/components/footer.tsx

@@ -1,3 +1,5 @@
+// noinspection SpellCheckingInspection
+
 import Image from "next/image";
 import React, {useEffect} from "react";
 import styles from "@/styles/components/footer.module.css";

website/src/components/infinteLoading.tsx

@@ -75,4 +75,4 @@ export function InfiniteLoading({searchQuery} : InfiniteLoadingProps) {
             </div>
         </>
     )
-};
+}

website/src/components/layout.tsx

@@ -3,7 +3,6 @@ import HtmlHeader from "@/components/html_header";
 import Navbar from "@/components/navbar";
 import Section from "@/components/section";
 import Footer from "@/components/footer";
-import ScrollToTop from "@/components/scroll_to_top";
 import PageHeader from "@/components/page_header";
 import styles from "@/styles/pages/account/index.module.css";
 import {Loading} from "@/components/loading";

website/src/components/page_header.tsx

@@ -62,7 +62,7 @@ export default function PageHeader({ children, size = "medium" }: PageHeaderProp
                     />
                 </div>
 
-                {/* This is the container for the header, it uses css to centre its contents*/}
+                {/* This is the container for the header, it uses css to centre it's contents*/}
                 <div className={styles.headerContainer + " gridCentre"}>
 
                     {/* This is the blurred background for what ever is made to be displayed in the header */}

website/src/components/plant_sections.tsx

@@ -345,10 +345,7 @@ interface SourceSectionProps{
  * @returns {JSX.Element} The rendered section component.
  */
 export function SourceSection({section} : SourceSectionProps){
-    let sourceItem = (
-        <>
-        </>
-    )
+    let sourceItem: JSX.Element
 
     switch (section.source_type){
         case "Internet":

website/src/components/slider.tsx

@@ -1,13 +1,15 @@
+// noinspection SpellCheckingInspection
+
 import React from "react";
 import "owl.carousel/dist/assets/owl.carousel.css";
 import "owl.carousel/dist/assets/owl.theme.default.css";
 import styles from "@/styles/components/slider.module.css";
 
 import dynamic from "next/dynamic";
 
-var $ = require("jquery");
+const $ = require("jquery");
 if (typeof window !== "undefined") {
-    // @ts-ignore   -  This is a hack to get around the fact that the window object doesn't like jquery in nextjs
+    // @ts-ignore   -  This is a hack to get around the fact that the window object doesn't like jquery in Next.js
     window.$ = window.jQuery = require("jquery");
 }
 

website/src/components/stats.tsx

@@ -3,7 +3,6 @@ import {FontAwesomeIcon} from "@fortawesome/react-fontawesome";
 import {faBookMedical, faBowlFood, faSeedling, faTools} from "@fortawesome/free-solid-svg-icons";
 import React, {useEffect, useRef, useState} from "react";
 import {getFromCache, saveToCache} from "@/lib/cache";
-import axios from "axios";
 import {useRouter} from "next/router";
 import {makeRequestWithToken} from "@/lib/api_tools";
 
@@ -34,7 +33,7 @@ export default function Stats(){
     async function fetchData() {
         try {
 
-            let res = null;
+            let res: null;
 
             const storedData = getFromCache("plant_stats");
 

website/src/lib/api_tools.ts

@@ -47,7 +47,7 @@ export async function checkApiPermissions(request: NextApiRequest, response: Nex
     }else{
 
         token = token.data
-        let requestURL = request.url
+        let requestURL: string | undefined
 
         // Remove any query parameters
         token = token.split("?")[0]
@@ -78,14 +78,14 @@ export async function checkApiPermissions(request: NextApiRequest, response: Nex
         // Parse the log
         let log = JSON.parse(api_key_data.api_key_logs)
 
-        // Check if the log is at its limit
+        // Check if the log is at it's limit
         if(log.length >= 100 && !checkPermissions(permissions, "data:logs:unlimitedApiLogEntries")){
 
-            // Remove the item at 1 because don't want to remove the first item as its the creation data
+            // Remove the item at 1 because don't want to remove the first item as it's the creation data
             log.splice(1, 1)
 
-            // Overwrite the new item to state that the log is at its limit
-            log[1] = {time: new Date().toISOString(), action: "Previous log entries have been removed as the log is at its limit of 100 entries"}
+            // Overwrite the new item to state that the log is at it's limit
+            log[1] = {time: new Date().toISOString(), action: "Previous log entries have been removed as the log is at it's limit of 100 entries"}
 
         }
 
@@ -153,8 +153,7 @@ export async function makeRequestWithToken (
 
     try {
         // Make the request
-        const response = await axios(axiosConfig);
-        return response;
+        return await axios(axiosConfig);
     } catch (error : any) {
         // Handle errors
         console.error('Request failed:', error.message);

website/src/lib/cache.ts

@@ -14,7 +14,7 @@ interface CacheItem {
  */
 export function getFromCache(id: string){
 
-    let item = null;
+    let item: null;
     item = sessionStorage.getItem(id);
 
     // Check if the item exists in the local storage

website/src/lib/plant_data.ts

@@ -84,7 +84,7 @@ export interface ImageMetaData {
 }
 
 /**
- * Meta data for a file, (attachment.meta)
+ * Metadata for a file, (attachment.meta)
  *
  * @see {@link AttachmentSectionData}
  */
@@ -818,7 +818,7 @@ export async function fetchPlant (id: number) {
 }
 
 /**
- * Will fix the paths of the attachments to be the proper path, this is because when uploading the attachments the path is set to the local path on the server, this will change it to the public path. The local path is used as the plant has no way of knowing its ID until it is saved to the database, it will ignore any attachments that start with http as they are already using the public path.
+ * Will fix the paths of the attachments to be the proper path, this is because when uploading the attachments the path is set to the local path on the server, this will change it to the public path. The local path is used as the plant has no way of knowing it's ID until it is saved to the database, it will ignore any attachments that start with http as they are already using the public path.
  *
  * @param {PlantData} plant - The plant data to fix the paths of
  *

website/src/lib/users.ts

@@ -326,7 +326,7 @@ export function getUserPermissions(user: RongoaUser | null) {
         permissions.api.plants.months.publicAccess = true;
         permissions.api.plants.random.publicAccess = true;
         permissions.api.plants.search.publicAccess = true;
-        permissions.api.plants.uses.publicAccess = true;;
+        permissions.api.plants.uses.publicAccess = true;
         permissions.api.user.data.publicAccess = true;
         permissions.api.user.plants.publicAccess = true;
 

website/src/pages/account/edit.tsx

@@ -1,17 +1,11 @@
-import HtmlHeader from "@/components/html_header";
-import Navbar from "@/components/navbar";
 import React, {useEffect, useRef, useState} from "react";
 import Section from "@/components/section";
-import Footer from "@/components/footer";
-import PageHeader from "@/components/page_header";
 import styles from "@/styles/pages/account/index.module.css"
 import {useSession} from "next-auth/react";
 import {ADMIN_USER_TYPE, EDITOR_USER_TYPE, MEMBER_USER_TYPE, RongoaUser, UserDatabaseDetails} from "@/lib/users";
 import {globalStyles} from "@/lib/global_css";
 import {useRouter} from "next/router";
-import {Error} from "@/components/error";
 import {FileInput, SmallInput, ValidationState} from "@/components/input_sections";
-import {Loading} from "@/components/loading";
 import {makeRequestWithToken} from "@/lib/api_tools";
 import {Layout} from "@/components/layout";
 
@@ -133,7 +127,7 @@ export default function EditAccount() {
         // Email is valid
         setValidUserEmail(["success", "no error"])
 
-        // Check that there is a image being uploaded
+        // Check that there is an image being uploaded
         if(userLocalImage !== null) {
 
             console.log(userLocalImage)

website/src/pages/account/index.tsx

@@ -1,14 +1,10 @@
-import HtmlHeader from "@/components/html_header";
-import Navbar from "@/components/navbar";
 import React, {useEffect, useRef, useState} from "react";
 import Section from "@/components/section";
-import Footer from "@/components/footer";
-import PageHeader from "@/components/page_header";
 import styles from "@/styles/pages/account/index.module.css"
 import statsStyles from "@/styles/components/stats.module.css"
 import {FontAwesomeIcon} from "@fortawesome/react-fontawesome";
-import {faCamera, faPerson, faSeedling} from "@fortawesome/free-solid-svg-icons";
-import {signIn, signOut, useSession} from "next-auth/react";
+import {faCamera, faSeedling} from "@fortawesome/free-solid-svg-icons";
+import {signOut, useSession} from "next-auth/react";
 import {
     ADMIN_USER_TYPE,
     checkUserPermissions,
@@ -24,9 +20,7 @@ import {DropdownSection} from "@/components/dropdown_section";
 import {useRouter} from "next/router";
 import Link from "next/link";
 import {getNamesInPreference, macronCodeToChar, numberDictionary, PlantData} from "@/lib/plant_data";
-import {Error} from "@/components/error";
 import {makeCachedRequest, makeRequestWithToken} from "@/lib/api_tools";
-import {Loading} from "@/components/loading";
 import {Layout} from "@/components/layout";
 
 export default function Account() {
@@ -113,7 +107,7 @@ export function AccountPage({dataID}: AccountPageProps){
 
         if(session?.user) {
 
-            // Not viewing a user so we are viewing our own account
+            // Not viewing a user, so we are viewing our own account
 
             // This is our account
             setMyAccount(true)
@@ -291,7 +285,7 @@ export function AccountPage({dataID}: AccountPageProps){
         localStorage.removeItem("userApiKeysData_" + userID)
 
         // Reload the data
-        fetchData(userID)
+        await fetchData(userID)
     }
 
 

website/src/pages/account/keys/[id].tsx

@@ -1,14 +1,8 @@
 import {useRouter} from "next/router";
 import React, {useEffect, useState} from "react";
 import {useSession} from "next-auth/react";
-import HtmlHeader from "@/components/html_header";
-import Navbar from "@/components/navbar";
 import Section from "@/components/section";
-import PageHeader from "@/components/page_header";
 import styles from "@/styles/pages/account/index.module.css";
-import {Loading} from "@/components/loading";
-import {Error} from "@/components/error";
-import Footer from "@/components/footer";
 import {makeCachedRequest, makeRequestWithToken} from "@/lib/api_tools";
 import {checkUserPermissions, getStrings, RongoaUser} from "@/lib/users";
 import {DropdownSection} from "@/components/dropdown_section";
@@ -62,7 +56,7 @@ export default function KeyViewer(){
                     apiUrl += "&publicUserID=" + user
                 }else{
                     // Send them to their account page
-                    router.push("/account")
+                    await router.push("/account")
                 }
 
             }

website/src/pages/account/keys/create.tsx

@@ -1,16 +1,11 @@
-import HtmlHeader from "@/components/html_header";
-import Navbar from "@/components/navbar";
 import React, {useEffect} from "react";
 import Section from "@/components/section";
-import Footer from "@/components/footer";
-import PageHeader from "@/components/page_header";
 import styles from "@/styles/pages/account/index.module.css"
 import {useSession} from "next-auth/react";
 import {useRouter} from "next/router";
 import {SmallInput, ValidationState} from "@/components/input_sections";
 import {getDefaultPermissions, getStrings, getUserPermissions, RongoaUser, UserPermissions} from "@/lib/users";
 import {makeRequestWithToken} from "@/lib/api_tools";
-import {Loading} from "@/components/loading";
 import {Error} from "@/components/error";
 import {Layout} from "@/components/layout";
 
@@ -146,7 +141,7 @@ export function AccountPage({dataID}: AccountPageProps){
 
         setLoading(false)
         // Go to the account page
-        router.push("/account/")
+        await router.push("/account/")
 
     }