modern vue.js app installed

derek-adair · Aug 17, 2023 · 85f10a6 · 85f10a6
1 parent 00494f3
commit 85f10a6
Show file tree

Hide file tree

Showing 16 changed files with 3,327 additions and 79 deletions.
diff --git a/ui/README.md b/ui/README.md
@@ -0,0 +1,57 @@
+# email-proxy ui
+
+This is a javascript app that will build, validate and submit contact forms to the email-proxy API. 
+
+## Recommended IDE Setup
+
+[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
+
+## Customize configuration
+
+See [Vite Configuration Reference](https://vitejs.dev/config/).
+
+## Project Setup
+
+```sh
+npm install
+```
+
+### Compile and Hot-Reload for Development
+
+```sh
+npm run dev
+```
+
+### Compile and Minify for Production
+
+```sh
+npm run build
+```
+
+### Run Unit Tests with [Vitest](https://vitest.dev/)
+
+```sh
+npm run test:unit
+```
+
+### Run End-to-End Tests with [Cypress](https://www.cypress.io/)
+
+```sh
+npm run test:e2e:dev
+```
+
+This runs the end-to-end tests against the Vite development server.
+It is much faster than the production build.
+
+But it's still recommended to test the production build with `test:e2e` before deploying (e.g. in CI environments):
+
+```sh
+npm run build
+npm run test:e2e
+```
+
+### Lint with [ESLint](https://eslint.org/)
+
+```sh
+npm run lint
+```
diff --git a/ui/cypress.config.js b/ui/cypress.config.js
@@ -0,0 +1,8 @@
+const { defineConfig } = require('cypress')
+
+module.exports = defineConfig({
+  e2e: {
+    specPattern: 'cypress/e2e/**/*.{cy,spec}.{js,jsx,ts,tsx}',
+    baseUrl: 'http://localhost:4173'
+  }
+})
diff --git a/ui/cypress/e2e/example.cy.js b/ui/cypress/e2e/example.cy.js
@@ -0,0 +1,8 @@
+// https://on.cypress.io/api
+
+describe('My First Test', () => {
+  it('visits the app root url', () => {
+    cy.visit('/')
+    cy.contains('h1', 'You did it!')
+  })
+})
diff --git a/ui/cypress/e2e/jsconfig.json b/ui/cypress/e2e/jsconfig.json
@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["es5", "dom"],
+    "types": ["cypress"]
+  },
+  "include": ["./**/*", "../support/**/*"]
+}
diff --git a/ui/cypress/fixtures/example.json b/ui/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"
+}
diff --git a/ui/cypress/support/commands.js b/ui/cypress/support/commands.js
@@ -0,0 +1,25 @@
+// ***********************************************
+// 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
+// ***********************************************
+//
+//
+// -- 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) => { ... })
diff --git a/ui/cypress/support/e2e.js b/ui/cypress/support/e2e.js
@@ -0,0 +1,20 @@
+// ***********************************************************
+// 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'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')
diff --git a/ui/index.html b/ui/index.html
@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <link rel="icon" href="/favicon.ico">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Vite App</title>
+  </head>
+  <body>
+    <div id="vue"></div>
+    <script type="module" src="/src/main.js"></script>
+  </body>
+</html>
diff --git a/ui/package.json b/ui/package.json
@@ -1,6 +1,34 @@
 {
+  "name": "email-proxy",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "preview": "vite preview",
+    "test:unit": "vitest",
+    "test:e2e": "start-server-and-test preview http://localhost:4173 'cypress run --e2e'",
+    "test:e2e:dev": "start-server-and-test 'vite dev --port 4173' http://localhost:4173 'cypress open --e2e'",
+    "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs --fix --ignore-path .gitignore",
+    "format": "prettier --write src/"
+  },
   "dependencies": {
-    "axios": "^1.3.4",
-    "vue": "^2.6.11"
+    "vee-validate": "^4.11.1",
+    "vue": "^3.3.4"
+  },
+  "devDependencies": {
+    "@rushstack/eslint-patch": "^1.3.2",
+    "@vitejs/plugin-vue": "^4.2.3",
+    "@vue/eslint-config-prettier": "^8.0.0",
+    "@vue/test-utils": "^2.4.1",
+    "cypress": "^12.17.2",
+    "eslint": "^8.45.0",
+    "eslint-plugin-cypress": "^2.13.3",
+    "eslint-plugin-vue": "^9.15.1",
+    "jsdom": "^22.1.0",
+    "prettier": "^3.0.0",
+    "start-server-and-test": "^2.0.0",
+    "vite": "^4.4.6",
+    "vitest": "^0.33.0"
   }
 }
diff --git a/ui/public/favicon.ico b/ui/public/favicon.ico
diff --git a/ui/src/App.vue b/ui/src/App.vue
@@ -0,0 +1,41 @@
+<template>
+    <div id="app">
+	<Form @submit="onSubmit">
+	    <Field name="email" type="email" :rules="validateEmail" />
+	    <ErrorMessage name="email" />
+	    <button>Sign up for newsletter</button>
+	    </form>
+    </div>
+</template>
+
+<script>
+import { Form, Field, ErrorMessage } from 'vee-validate';
+
+export default {
+    components: {
+	Form,
+	Field,
+	ErrorMessage,
+    },
+    methods: {
+	onSubmit(values) {
+	    console.log(values);
+	},
+	validateEmail(value) {
+	    // if the field is empty
+	    if (!value) {
+		return 'This field is required';
+	    }
+
+	    // if the field is not a valid email
+	    const regex = /^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$/i;
+	    if (!regex.test(value)) {
+		return 'This field must be a valid email';
+	    }
+
+	    // All is good
+	    return true;
+	},
+    },
+}; 
+</script>
diff --git a/ui/src/components/__tests__/HelloWorld.spec.js b/ui/src/components/__tests__/HelloWorld.spec.js
@@ -0,0 +1,11 @@
+import { describe, it, expect } from "vitest";
+
+import { mount } from "@vue/test-utils";
+import HelloWorld from "../HelloWorld.vue";
+
+describe("HelloWorld", () => {
+  it("renders properly", () => {
+    const wrapper = mount(HelloWorld, { props: { msg: "Hello Vitest" } });
+    expect(wrapper.text()).toContain("Hello Vitest");
+  });
+});
diff --git a/ui/src/main.js b/ui/src/main.js
@@ -0,0 +1,6 @@
+import "vee-validate/dist/vee-validate.js";
+
+import { createApp } from "vue";
+import App from "./App.vue";
+
+createApp(App).mount("#vue");
diff --git a/ui/vite.config.js b/ui/vite.config.js
@@ -0,0 +1,16 @@
+import { fileURLToPath, URL } from 'node:url'
+
+import { defineConfig } from 'vite'
+import vue from '@vitejs/plugin-vue'
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  plugins: [
+    vue(),
+  ],
+  resolve: {
+    alias: {
+      '@': fileURLToPath(new URL('./src', import.meta.url))
+    }
+  }
+})
diff --git a/ui/vitest.config.js b/ui/vitest.config.js
@@ -0,0 +1,18 @@
+import { fileURLToPath } from 'node:url'
+import { mergeConfig, defineConfig } from 'vite'
+import { configDefaults } from 'vitest/config'
+import viteConfig from './vite.config'
+
+export default mergeConfig(
+  viteConfig,
+  defineConfig({
+    test: {
+      environment: 'jsdom',
+      exclude: [...configDefaults.exclude, 'e2e/*'],
+      root: fileURLToPath(new URL('./', import.meta.url)),
+      transformMode: {
+        web: [/\.[jt]sx$/]
+      }
+    }
+  })
+)