chore: add Cypress to the project

.gitignore

@@ -33,3 +33,7 @@ yarn-error.log*
 .turbo
 
 *.tsbuildinfo
+
+#cypress screenshots and videos
+apps/app/cypress/screenshots
+apps/app/cypress/videos

apps/app/.eslintrc.js

@@ -1,6 +1,6 @@
 module.exports = {
 	root: true,
-	extends: ["devfaq", "plugin:storybook/recommended"],
+	extends: ["devfaq", "plugin:storybook/recommended", "plugin:cypress/recommended"],
 	parserOptions: {
 		tsconfigRootDir: __dirname,
 	},

apps/app/cypress.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from "cypress";
+
+export default defineConfig({
+	e2e: {
+		// setupNodeEvents(on, config) {
+		// implement node event listeners here
+		// },
+		baseUrl: "http://app.devfaq.localhost:3000",
+	},
+});

apps/app/cypress/e2e/helloWorld.cy.ts

@@ -0,0 +1,8 @@
+describe("hello world", () => {
+	it("visit home page", () => {
+		cy.visit("/");
+		cy.get("h1").should("contain", "DevFAQ");
+	});
+});
+
+export {};

apps/app/cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+	"name": "Using fixtures to represent data",
+	"email": "[email protected]",
+	"body": "Fixtures are a great way to mock data for responses to routes"
+}

apps/app/cypress/support/commands.ts

@@ -0,0 +1,39 @@
+/// <reference types="cypress" />
+// ***********************************************
+// This example commands.ts shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })
+//
+// declare global {
+//   namespace Cypress {
+//     interface Chainable {
+//       login(email: string, password: string): Chainable<void>
+//       drag(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       dismiss(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       visit(originalFn: CommandOriginalFn, url: string, options: Partial<VisitOptions>): Chainable<Element>
+//     }
+//   }
+// }
+
+export {};

apps/app/cypress/support/e2e.ts

@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/e2e.ts is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import "./commands";
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

apps/app/package.json

@@ -11,7 +11,9 @@
 		"lint:fix": "next lint --dir . --fix --quiet",
 		"check-types": "tsc --noEmit",
 		"storybook": "storybook dev -p 6006",
-		"build-storybook": "storybook build"
+		"build-storybook": "storybook build",
+		"cypress:open": "cypress open",
+		"cypress:run": "cypress run"
 	},
 	"dependencies": {
 		"@headlessui/react": "1.7.7",
@@ -54,8 +56,10 @@
 		"@vitejs/plugin-react": "3.0.0",
 		"autoprefixer": "^10.4.13",
 		"css-loader": "^6.7.3",
+		"cypress": "12.5.1",
 		"eslint": "8.31.0",
 		"eslint-config-devfaq": "workspace:*",
+		"eslint-plugin-cypress": "2.12.1",
 		"eslint-plugin-storybook": "^0.6.8",
 		"jsdom": "20.0.3",
 		"openapi-types": "workspace:*",

package.json

@@ -13,7 +13,9 @@
 		"lint:fix": "turbo run lint:fix --parallel",
 		"format": "prettier --write .",
 		"check-types": "turbo run check-types --parallel",
-		"prepare": "husky install"
+		"prepare": "husky install",
+		"cypress:open": "turbo run cypress:open",
+		"cypress:run": "turbo run cypress:run"
 	},
 	"resolutions": {
 		"@mdx-js/mdx": "2.1.5",