Test to master (#19)

Merges in: - [DN-98](https://designaroni.atlassian.net/browse/DN-98) - [DN-34](https://designaroni.atlassian.net/browse/DN-34) - [DN-49](https://designaroni.atlassian.net/browse/DN-49) - [DN-93](https://designaroni.atlassian.net/browse/DN-93) - [DN-28](https://designaroni.atlassian.net/browse/DN-29) - [DN-97](https://designaroni.atlassian.net/browse/DN-97) - [DN-9](https://designaroni.atlassian.net/browse/DN-9)
Designaroni · Dec 26, 2022 · 19ef544 · 19ef544 · vercel · Dec 26, 2022
2 parents 8565d3d + 605a4ce
commit 19ef544
Show file tree

Hide file tree

Showing 11 changed files with 1,273 additions and 21 deletions.
diff --git a/.commitlintrc.js b/.commitlintrc.js
@@ -0,0 +1,8 @@
+module.exports = {
+  extends: ["@commitlint/config-conventional"],
+  rules: {
+    "body-max-line-length": [0],
+    "footer-max-line-length": [0],
+    "subject-case": [2, "always", ["sentence-case", "lower-case"]],
+  },
+};
diff --git a/.czrc b/.czrc
@@ -0,0 +1,3 @@
+{
+  "path": "@commitlint/cz-commitlint"
+}
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,73 @@
+![Replace me with a new gif](https://media.giphy.com/media/n3p6JiIG0TzCU/giphy-downsized.gif)
+
+## Description
+
+[//]: # 'Replace "JIRA-ISSUE" in the link below with the Jira Task ex: DN-000'
+
+[JIRA ticket](https://designaroni.atlassian.net/browse/JIRA-ISSUE)
+
+[//]: # "What changes are made in the pull request? minor, major & chore or cleanup tasks..."
+
+## Documentation
+
+[//]: # "Provide links to in-house documentation for this work or any third party documentation used"
+
+## Impacted areas of code & app functionality
+
+[//]: # "Describe impacted areas and areas affected by this change."
+
+## How to recreate & verify
+
+[//]: # "Nuerotically list steps needed to recreate the issue. Seperately list steps to verify the fix or verify that all require changes satisfy the ticket requirements."
+
+**Steps to recreate:**
+
+- start up the app...
+- navigate to...
+- click X, Y & Z...
+- see the bug or issue
+
+**Steps to verify:**
+
+- start up the app...
+- navigate to...
+- ensure X, Y & Z pass quality & visual checks...
+- ensure A, B, & C satifies ticket requirements...
+
+## Checklists
+
+### Pull Request Author
+
+I have verified...
+
+- [ ] Recreate / Verification steps can be followed by any reviewer
+- [ ] All test and lint checks pass locally
+  - [ ] New code includes test coverage
+- [ ] Environment Deployment checks pass
+- [ ] Automated code scanning passes quality & coverage checks
+- [ ] Legacy & comment code cleanup
+- [ ] Satisfies ticket requirements
+  - [ ] defined or implied code style guide
+  - [ ] safely implements third-party documentation
+- [ ] Runs error-free
+- [ ] Effective commit messages
+- [ ] User-friendly errors
+- [ ] Work prevents exposing sensitive information
+- [ ] Formal documentation in Jira or README.md
+
+### Code Reviewer:
+
+I have verified...
+
+- [ ] All automated test and lint checks pass
+  - [ ] New code includes test coverage
+- [ ] Environment Deployment checks pass
+- [ ] Automated code scanning passes quality & coverage checks
+- [ ] Satisfies ticket requirements
+  - [ ] defined or implied code style guide
+  - [ ] safely implements third-party documentation
+- [ ] Runs error-free
+- [ ] Effective commit messages
+- [ ] User-friendly errors
+- [ ] Work prevents exposing sensitive information
+- [ ] Formal documentation in Jira or README.md
diff --git a/.gitignore b/.gitignore
@@ -1,39 +1,74 @@
 # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 
+############################
 # dependencies
+############################
+
 /node_modules
 /.pnp
 .pnp.js
 
+############################
 # testing
+############################
+
 /coverage
 
+############################
 # next.js
+############################
+
 /.next/
 /out/
 *.report.html
 
+############################
 # production
+############################
 /build
 
+############################
 # misc
+############################
+
 .DS_Store
 *.pem
 
+############################
 # debug
+############################
+
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 .pnpm-debug.log*
 
+############################
 # local env files
+############################
+
 .env*.local
 
+############################
 # vercel
+############################
+
 .vercel
 
+############################
 # typescript
+############################
+
 *.tsbuildinfo
 
+############################
 # custom
+############################
+
 .pages_api
+
+############################
+# VSCode
+############################
+
+/.vscode
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit 
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Ian Roberts
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,3 +1,27 @@
+[![Next JS](https://badgen.net/badge/NextJs/v.12.2.5/blue)](https://nextjs.org/)
+[![TypeScript](https://badgen.net/badge/icon/typescript?icon=typescript&label)](https://www.typescriptlang.org/)
+[![GraphQL](https://badgen.net/badge/icon/graphql?icon=graphql&label)](https://graphql.org/)
+[![Framer Motion](https://badgen.net/badge/Framer%20Motion/v6.5.1/blue)](https://www.framer.com/motion/)
+[![Phosphor Icons](https://badgen.net/badge/Phosphor%20Icons/v1.4.1/blue)](https://phosphoricons.com/)
+[![SASS](https://badgen.net/badge/SASS/v1.5.1/blue)](https://sass-lang.com/)
+[![CSS Modules](https://badgen.net/badge/css/CSS%20Modules/blue)](https://github.com/css-modules/css-modules)
+[![Prettier](https://badgen.net/badge/Prettier/v2.6.2/blue)](https://prettier.io/)
+[![ESLint](https://badgen.net/badge/ESLint/v8.2.0/blue)](https://eslint.org/)
+[![Stylelint](https://badgen.net/badge/stylelint/v14.8.2/blue)](https://stylelint.io/)
+[![Vercel Designaroni-next](https://badgen.net/badge/icon/vercel?icon=vercel&label)](https://vercel.com/designaroni/designaroni-next)
+[![Jira](https://badgen.net/badge/icon/jira?icon=jira&label)](https://designaroni.atlassian.net/jira/software/projects/DN/boards/1)
+[![Designaroni Next Github](https://badgen.net/badge/icon/github?icon=github&label)](https://github.com/designaroni/designaroni-next)
+[![Dependabot](https://badgen.net/badge/icon/dependabot?icon=dependabot&label)](https://github.com/Designaroni/designaroni-next/security/dependabot)
+[![Git SCM](https://badgen.net/badge/icon/git?icon=git&label)](https://git-scm.com/)
+![Terminal](https://badgen.net/badge/icon/terminal?icon=terminal&label)
+![MIT License](https://badgen.net/badge/license/MIT/blue)
+
+[![SonarCloud](https://sonarcloud.io/images/project_badges/sonarcloud-orange.svg)](https://sonarcloud.io/summary/new_code?id=Designaroni_designaroni-next)
+
+<!-- https://badgen.net/badge/icon/npm?icon=npm&label -->
+
+---
+
 # Environment Variables
 
 - Copy `env.example` to `.env.local`

diff --git a/package.json b/package.json
@@ -7,6 +7,7 @@
     "dev": "next dev",
     "build": "next build",
     "start": "next start",
+    "commit": "git-cz",
     "lint": "yarn lint:ts; yarn lint:js; yarn lint:scss",
     "lint:js": "next lint",
     "lint:scss": "yarn stylelint '**/*.scss'",
@@ -16,6 +17,7 @@
     "@octokit/core": "^4.0.5",
     "@types/fontfaceobserver": "^2.1.0",
     "@types/markdown-to-jsx": "^7.0.1",
+    "@vercel/analytics": "^0.1.6",
     "eslint-config-airbnb-typescript": "^17.0.0",
     "eslint-config-prettier": "^8.5.0",
     "fontfaceobserver": "^2.3.0",
@@ -34,18 +36,23 @@
     "stylelint-order": "^5.0.0"
   },
   "devDependencies": {
+    "@commitlint/cli": "^17.3.0",
+    "@commitlint/config-conventional": "^17.3.0",
+    "@commitlint/cz-commitlint": "^17.3.0",
     "@types/node": "17.0.23",
     "@types/react": "18.0.0",
     "@types/react-dom": "18.0.0",
     "@typescript-eslint/eslint-plugin": "^5.23.0",
     "@typescript-eslint/parser": "^5.23.0",
+    "commitizen": "^4.2.6",
     "eslint": "^7.32.0 || ^8.2.0",
     "eslint-config-airbnb": "^19.0.4",
     "eslint-config-next": "12.1.4",
     "eslint-plugin-import": "^2.25.3",
     "eslint-plugin-jsx-a11y": "^6.5.1",
     "eslint-plugin-react": "^7.28.0",
     "eslint-plugin-react-hooks": "^4.3.0",
+    "husky": "^8.0.2",
     "prettier": "2.6.2",
     "stylelint-config-css-modules": "^4.1.0",
     "typescript": "4.6.3"

diff --git a/pages/_app.tsx b/pages/_app.tsx
@@ -8,6 +8,7 @@ import FontFaceObserver from "fontfaceobserver";
 import Layout from "@/components/layout";
 import { LoadingScreen } from "@/components/loading";
 import GoogleAnalytics from "@/components/seo/analytics/googleanalytics";
+import { Analytics } from "@vercel/analytics/react";
 import "@/styles/globals.scss";
 
 export interface CustomAppProps extends AppProps {
@@ -73,6 +74,7 @@ const MyApp = ({ Component, pageProps }: CustomAppProps) => {
         // ]}
         // loadingMessage="Waiting for snow to fall..."
         />
+        <Analytics />
       </>
     );
 
@@ -81,6 +83,7 @@ const MyApp = ({ Component, pageProps }: CustomAppProps) => {
       <>
         <GoogleAnalytics />
         <LoadingScreen loadingMessage="Looks like we're still hibernating, check back later" />
+        <Analytics />
       </>
     );
 
@@ -93,6 +96,7 @@ const MyApp = ({ Component, pageProps }: CustomAppProps) => {
         topLevelPageNames={topLevelPageNames}
       >
         <Component {...pageProps} />
+        <Analytics />
       </Layout>
     </>
   );