Revised approach to dashboard

.env.example

@@ -1,4 +1,5 @@
 # DEVELOPMENT TOOLS
 # Ideally, don't add them to production deployment envs
 # Change to true if we want to log data
-NEXT_PUBLIC_SHOW_LOGGER="false"
+# NEXT_PUBLIC_SHOW_LOGGER="false"
+NEXT_PUBLIC_BEARER_TOKEN="my-secret-token"

.eslintrc.js

@@ -4,7 +4,12 @@ module.exports = {
     es2021: true,
     node: true,
   },
-  plugins: ['@typescript-eslint', 'simple-import-sort', 'unused-imports'],
+  plugins: [
+    '@typescript-eslint',
+    'simple-import-sort',
+    'unused-imports',
+    'cypress',
+  ],
   extends: [
     'eslint:recommended',
     'next',
@@ -77,6 +82,15 @@ module.exports = {
       },
     ],
     //#endregion  //*======== Import Sort ===========
+
+    // #region   //*========= Cypress files =========
+    '@typescript-eslint/no-namespace': [
+      'error',
+      {
+        allowDeclarations: true,
+      },
+    ],
+    // #endregion   //*========= Cypress files =========
   },
   globals: {
     React: true,

.github/workflows/codeql.yml

@@ -45,7 +45,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL

.github/workflows/lint.yml

@@ -1,4 +1,4 @@
-name: Code Check
+name: Code Lint and Test
 
 on:
   push:
@@ -8,19 +8,19 @@ on:
 
 jobs:
   lint:
-    name: ⬣ ESLint, ʦ TypeScript, 💅 Prettier
+    name: ⬣ ESLint, ʦ TypeScript, 💅 Prettier, ✅ Cypress
     runs-on: ubuntu-latest
     steps:
       - name: ⬇️ Checkout repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
 
       - name: ⎔ Setup node
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8
         with:
           node-version: 21
 
-      - uses: pnpm/action-setup@v2
-        name: Install pnpm
+      - name: Install pnpm
+        uses: pnpm/action-setup@d882d12c64e032187b2edb46d3a0d003b7a43598
         with:
           version: 8
           run_install: true
@@ -33,3 +33,12 @@ jobs:
 
       - name: 💅 Prettier check
         run: pnpm format:check
+
+      - name: ✅ Cypress tests
+        uses: cypress-io/github-action@1b70233146622b69e789ccdd4f9452adc638d25a
+        with:
+          browser: chrome
+          build: pnpm build
+          component: true
+          start: pnpm start
+          wait-on: 'http://localhost:3000'

.husky/commit-msg

@@ -1,4 +1 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npx --no-install commitlint --edit $1
+pnpm exec commitlint --edit $1

.husky/pre-commit

@@ -1,4 +1,2 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npx lint-staged
+pnpm typecheck
+pnpm exec lint-staged

.tool-versions

@@ -1 +1 @@
-nodejs 21.5.0
+nodejs 21.6.0

.vscode/settings.json

@@ -6,7 +6,6 @@
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.formatOnSave": true,
   "editor.tabSize": 2,
-
   "python.terminal.activateEnvironment": false,
   // Tailwind CSS Autocomplete, add more if used in projects
   "tailwindCSS.classAttributes": [

README.md

@@ -11,10 +11,12 @@ Table of Contents:
 - [Getting Started](#getting-started)
   - [Install dependencies](#install-dependencies)
   - [Run the development server](#run-the-development-server)
+  - [Connecting to the server](#connecting-to-the-server)
   - [Commit Message Convention](#commit-message-convention)
   - [Contribution Guidelines](#contribution-guidelines)
 - [Tests](#tests)
 - [Deployment](#deployment)
+- [URL Structure](#url-structure)
 - [Resources](#resources)
 
 ## Setting up the project
@@ -43,9 +45,14 @@ You can start the server using this command:
 pnpm dev
 ```
 
-csd
 Open [http://localhost:3000](http://localhost:3000) with your browser.
 
+### Connecting to the server
+
+Currently the standard is to run the backend locally. Follow instructions [here](https://github.com/Slick-Telemetry/backend/blob/dev/README.md) for setup.
+
+To make calls to API you need to duplicate the `.env.example` file to define a client-side bearer token
+
 ### Commit Message Convention
 
 This project is using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), it is mandatory to use it to commit changes.
@@ -78,14 +85,43 @@ This project is using [conventional commits](https://www.conventionalcommits.org
   - `Squash and merge` can be used when the commits _**DON'T**_ need to be individually brought in to the target branch.
   - [More information](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github).
 
+- **Jira issue linking**
+  - Commits and PRs **_must_** be linked to a Jira issue.
+  - To do so, include the Jira issue key in the PR title and/or the commit message after the conventional commit type.
+  - [More information on Jira smart commits](https://support.atlassian.com/jira-software-cloud/docs/process-issues-with-smart-commits/).
+
 ## Tests
 
 // TODO [cypress](https://www.cypress.io/)
 
+> [!WARNING]
+> Cypress does not officially support Next v14. If you enncounter any errors or issues please report them [here](https://github.com/Slick-Telemetry/frontend/issues)
+
+- **Background**
+
+  - Cypress uses chai based assertions
+
+- **Running Cypress**
+
+  - `pnpm run cypress:open`
+
 ## Deployment
 
 // TODO [vercel](https://vercel.com/)
 
+## URL Structure
+
+```
+`/`
+├── Results of past seasons
+└──`[season]` -> year
+    └── `[event name]` -> event name of race in season
+        └── `[session]` -> session of race
+            └── `[driver]` -> driverId in race session
+                ├── `/` -> ???
+                └── `/telemetry` -> ???
+```
+
 ## Resources
 
-Key tools in use: `daisy-ui`, `tailwindcss`, `react`, `nextjs`, `pnpm`
+Key tools in use: `daisy-ui`, `tailwindcss`, `react`, `nextjs`, `pnpm`, `cypress`

commitlint.config.js

@@ -3,6 +3,11 @@ module.exports = {
   rules: {
     //   TODO Add Scope Enum Here
     // 'scope-enum': [2, 'always', ['yourscope', 'yourscope']],
+    'subject-case': [
+      0,
+      'always',
+      ['sentence-case', 'start-case', 'pascal-case'],
+    ],
     'type-enum': [
       2,
       'always',