feat(demo-app): ✨ add demo app example

.vscode/settings.json

@@ -12,6 +12,7 @@
 		"editor.defaultFormatter": "esbenp.prettier-vscode"
 	},
 	"conventionalCommits.scopes": [
-		"txs-tracer-core"
+		"txs-tracer-core",
+		"demo-app"
 	]
 }

apps/demo-app-e2e/.eslintrc.json

@@ -0,0 +1,17 @@
+{
+	"extends": ["plugin:cypress/recommended", "../../.eslintrc.json"],
+	"ignorePatterns": ["!**/*"],
+	"overrides": [
+		{
+			"files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+			"rules": {}
+		},
+		{
+			"files": ["src/plugins/index.js"],
+			"rules": {
+				"@typescript-eslint/no-var-requires": "off",
+				"no-undef": "off"
+			}
+		}
+	]
+}

apps/demo-app-e2e/cypress.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from 'cypress';
+import { nxE2EPreset } from '@nrwl/cypress/plugins/cypress-preset';
+
+export default defineConfig({
+	e2e: nxE2EPreset(__dirname, {
+		bundler: 'vite',
+	}),
+});

apps/demo-app-e2e/project.json

@@ -0,0 +1,30 @@
+{
+	"name": "demo-app-e2e",
+	"$schema": "../../node_modules/nx/schemas/project-schema.json",
+	"sourceRoot": "apps/demo-app-e2e/src",
+	"projectType": "application",
+	"targets": {
+		"e2e": {
+			"executor": "@nrwl/cypress:cypress",
+			"options": {
+				"cypressConfig": "apps/demo-app-e2e/cypress.config.ts",
+				"devServerTarget": "demo-app:serve:development",
+				"testingType": "e2e"
+			},
+			"configurations": {
+				"production": {
+					"devServerTarget": "demo-app:serve:production"
+				}
+			}
+		},
+		"lint": {
+			"executor": "@nrwl/linter:eslint",
+			"outputs": ["{options.outputFile}"],
+			"options": {
+				"lintFilePatterns": ["apps/demo-app-e2e/**/*.{js,ts}"]
+			}
+		}
+	},
+	"tags": [],
+	"implicitDependencies": ["demo-app"]
+}

apps/demo-app-e2e/src/e2e/app.cy.ts

@@ -0,0 +1,13 @@
+import { getGreeting } from '../support/app.po';
+
+describe('demo-app', () => {
+	beforeEach(() => cy.visit('/'));
+
+	it('should display welcome message', () => {
+		// Custom command example, see `../support/commands.ts` file
+		cy.login('my-email@something.com', 'myPassword');
+
+		// Function helper example, see `../support/app.po.ts` file
+		getGreeting().contains('Welcome demo-app');
+	});
+});

apps/demo-app-e2e/src/fixtures/example.json

@@ -0,0 +1,4 @@
+{
+	"name": "Using fixtures to represent data",
+	"email": "hello@cypress.io"
+}

apps/demo-app-e2e/src/support/app.po.ts

@@ -0,0 +1 @@
+export const getGreeting = () => cy.get('h1');

apps/demo-app-e2e/src/support/commands.ts

@@ -0,0 +1,33 @@
+// ***********************************************
+// This example commands.js 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
+// ***********************************************
+
+// eslint-disable-next-line @typescript-eslint/no-namespace
+declare namespace Cypress {
+	// eslint-disable-next-line @typescript-eslint/no-unused-vars
+	interface Chainable<Subject> {
+		login(email: string, password: string): void;
+	}
+}
+//
+// -- This is a parent command --
+Cypress.Commands.add('login', (email, password) => {
+	console.log('Custom command example: 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) => { ... })

apps/demo-app-e2e/src/support/e2e.ts

@@ -0,0 +1,17 @@
+// ***********************************************************
+// This example support/index.js 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';

apps/demo-app-e2e/tsconfig.json

@@ -0,0 +1,10 @@
+{
+	"extends": "../../tsconfig.base.json",
+	"compilerOptions": {
+		"sourceMap": false,
+		"outDir": "../../dist/out-tsc",
+		"allowJs": true,
+		"types": ["cypress", "node"]
+	},
+	"include": ["src/**/*.ts", "src/**/*.js", "cypress.config.ts"]
+}

apps/demo-app/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+	"extends": ["plugin:@nrwl/nx/react", "../../.eslintrc.json"],
+	"ignorePatterns": ["!**/*"],
+	"overrides": [
+		{
+			"files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+			"rules": {}
+		},
+		{
+			"files": ["*.ts", "*.tsx"],
+			"rules": {}
+		},
+		{
+			"files": ["*.js", "*.jsx"],
+			"rules": {}
+		}
+	]
+}

apps/demo-app/index.html

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="en">
+	<head>
+		<meta charset="utf-8" />
+		<title>DemoApp</title>
+		<base href="/" />
+
+		<meta name="viewport" content="width=device-width, initial-scale=1" />
+		<link rel="icon" type="image/x-icon" href="/favicon.ico" />
+	</head>
+	<body>
+		<div id="root"></div>
+		<script type="module" src="/src/main.tsx"></script>
+	</body>
+</html>

apps/demo-app/project.json

@@ -0,0 +1,72 @@
+{
+	"name": "demo-app",
+	"$schema": "../../node_modules/nx/schemas/project-schema.json",
+	"sourceRoot": "apps/demo-app/src",
+	"projectType": "application",
+	"targets": {
+		"build": {
+			"executor": "@nrwl/vite:build",
+			"outputs": ["{options.outputPath}"],
+			"defaultConfiguration": "production",
+			"options": {
+				"outputPath": "dist/apps/demo-app"
+			},
+			"configurations": {
+				"development": {
+					"mode": "development"
+				},
+				"production": {
+					"mode": "production"
+				}
+			}
+		},
+		"serve": {
+			"executor": "@nrwl/vite:dev-server",
+			"defaultConfiguration": "development",
+			"options": {
+				"buildTarget": "demo-app:build"
+			},
+			"configurations": {
+				"development": {
+					"buildTarget": "demo-app:build:development",
+					"hmr": true
+				},
+				"production": {
+					"buildTarget": "demo-app:build:production",
+					"hmr": false
+				}
+			}
+		},
+		"preview": {
+			"executor": "@nrwl/vite:preview-server",
+			"defaultConfiguration": "development",
+			"options": {
+				"buildTarget": "demo-app:build"
+			},
+			"configurations": {
+				"development": {
+					"buildTarget": "demo-app:build:development"
+				},
+				"production": {
+					"buildTarget": "demo-app:build:production"
+				}
+			}
+		},
+		"test": {
+			"executor": "@nrwl/vite:test",
+			"outputs": ["coverage/apps/demo-app"],
+			"options": {
+				"passWithNoTests": true,
+				"reportsDirectory": "../../coverage/apps/demo-app"
+			}
+		},
+		"lint": {
+			"executor": "@nrwl/linter:eslint",
+			"outputs": ["{options.outputFile}"],
+			"options": {
+				"lintFilePatterns": ["apps/demo-app/**/*.{ts,tsx,js,jsx}"]
+			}
+		}
+	},
+	"tags": []
+}

apps/demo-app/src/app/app.spec.tsx

@@ -0,0 +1,25 @@
+import { render } from '@testing-library/react';
+
+import { BrowserRouter } from 'react-router-dom';
+
+import App from './app';
+
+describe('App', () => {
+	it('should render successfully', () => {
+		const { baseElement } = render(
+			<BrowserRouter>
+				<App />
+			</BrowserRouter>,
+		);
+		expect(baseElement).toBeTruthy();
+	});
+
+	it('should have a greeting as the title', () => {
+		const { getByText } = render(
+			<BrowserRouter>
+				<App />
+			</BrowserRouter>,
+		);
+		expect(getByText(/Welcome demo-app/gi)).toBeTruthy();
+	});
+});

apps/demo-app/src/app/app.tsx

@@ -0,0 +1,56 @@
+import styled from '@emotion/styled';
+
+import NxWelcome from './nx-welcome';
+
+import { Route, Routes, Link } from 'react-router-dom';
+
+const StyledApp = styled.div`
+	// Your style here
+`;
+
+export function App() {
+	return (
+		<StyledApp>
+			<NxWelcome title="demo-app" />
+
+			{/* START: routes */}
+			{/* These routes and navigation have been generated for you */}
+			{/* Feel free to move and update them to fit your needs */}
+			<br />
+			<hr />
+			<br />
+			<div role="navigation">
+				<ul>
+					<li>
+						<Link to="/">Home</Link>
+					</li>
+					<li>
+						<Link to="/page-2">Page 2</Link>
+					</li>
+				</ul>
+			</div>
+			<Routes>
+				<Route
+					path="/"
+					element={
+						<div>
+							This is the generated root route.{' '}
+							<Link to="/page-2">Click here for page 2.</Link>
+						</div>
+					}
+				/>
+				<Route
+					path="/page-2"
+					element={
+						<div>
+							<Link to="/">Click here to go back to root page.</Link>
+						</div>
+					}
+				/>
+			</Routes>
+			{/* END: routes */}
+		</StyledApp>
+	);
+}
+
+export default App;