Frontend Challenge

.gitignore

@@ -0,0 +1,29 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+.DS_Store
+dist
+dist-ssr
+*.local
+
+/cypress/videos/
+/cypress/screenshots/
+
+# Editor directories and files
+.vscode
+!.vscode/extensions.json
+.idea
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+coverage

CHALLENGE.md

@@ -0,0 +1,81 @@
+## Challenge
+
+Our goal is to understand:
+
+-   How knowledgeable you are
+-   How well you structure your app
+-   How well can you visually reproduce a mockup
+
+Some restrictions:
+
+-   Use the Vue javascript framework and its Component system
+-   Don't use a UI framework like Bootstrap
+
+Your challenge will consist of the following:
+
+You'll have to build a small web app that is able to **fetch data** from an endpoint we provide, **list the data** from the endpoint, allow **editing the data**, **adding and removing** rows, and then **pushing the data** to another endpoint.
+
+Please fork this repo and commit your changes to the fork.
+
+Here is a preview of what we are expecting:
+
+![Sample](_README_assets/sample.png)
+
+Keep in mind that we may ask you about some of the decisions you made while building the app.
+
+## Important information to complete the challenge
+
+### Data source
+
+Fetch the data from this endpoint [http://www.mocky.io/v2/5ae1c5792d00004d009d7e5c](http://www.mocky.io/v2/5ae1c5792d00004d009d7e5c)
+
+Using Mocky should produce no cross origin errors and should work fine for this challenge. If you do find issues, it's OK to copy the JSON into your preferred method to then provide the data to the app.
+
+### Assets, measurements, and other details
+
+Inside this repository you'll find a folder named `assets-for-challenge`. Inside this folder you can find all the icons we expect you to use, in multiple formats, use what you think is best.
+
+## Detailed comments on each element
+
+![Elements Numbered](_README_assets/challenge-elements-numbered.png)
+
+**Functionality**
+
+The app should let the user do the following:
+
+-   **1** - _Get data_ button. When the user **clicks on this button**, your app will **get the data from the URL** in [Data source](#Data source) and fill the list
+-   **2** - _Upload data_ button. When the user **clicks on this button**, your app will **make a POST request to the same url** as the _Get data_ button. You should send the latest information on the list using the same structure as you have received it.
+-   **3** - _Custom checkbox_. When the user **clicks on the checkbox**, it will become checked. It will not have any other functionality.
+-   **4** - _Add line_ button. When the user **clicks on this button**, a **new row will be added to the list** and the user should be able to **write text in both fields**.
+-   **5** - _Delete row_ button. This button should be **visible only when hovering** each row item. When the user **clicks on this button**, your app will **remove that row** from the list.
+-   **6** - List _item title_ **This title should be editable**.
+-   **7** - List _item content_. **This content should be editable**.
+-   **8** - _App title_. No functionality.
+-   **9** - _Person icon_ linked to each row. No functionality.
+
+Notes:
+
+-   Don't worry about the blank state before loading the content.
+
+**Style Attributes**
+
+These are some and useful details about some of the elements
+
+-   **3** - The checkbox is 16px wide and 16px high. The purple color is `#859EFF`
+-   **6** - The font-family of the _item title_ is `Montserrat`, the weight is `SemiBold`, the size is `16px`, and the color is `#566074`
+-   **7** - The font-family of the _item content_ is `Open Sans`, the weight is `Regular`, the size is `16px`, and the color is `#778195`
+-   **8** - The font-family of the _app title_ is `Montserrat`, the weight is `Medium`, the size is `18px`, and the color is `#414C5E`
+
+The data above is enough to complete challenge. We also include the source Sketch file in the repository, in case you want to check the original file. You can find it in `_README_assets/Challenge.sketch`
+
+## Typography
+
+-   You can find [Montserrat on Google Fonts](https://fonts.google.com/specimen/Montserrat)
+-   You can find [Open Sans on Google Fonts](https://fonts.google.com/specimen/Open+Sans)
+
+## Bonus points:
+
+-   Keeping in mind accessibility
+-   Adding tests to your components and app
+-   Using a store (Vuex) to manage the application data
+-   Using vue-router to prepare the app for a future where it would have multiple routes

README.md

@@ -1,79 +1,81 @@
-# Frontend Challenge
-
-Our goal is to understand:
-- How knowledgeable you are
-- How well you structure your app
-- How well can you visually reproduce a mockup
-
-Some restrictions:
-- Use the Vue javascript framework and its Component system
-- Don't use a UI framework like Bootstrap
-
-Your challenge will consist of the following:
-
-You'll have to build a small web app that is able to **fetch data** from an endpoint we provide, **list the data** from the endpoint, allow **editing the data**, **adding and removing** rows, and then **pushing the data** to another endpoint.
-
-Please fork this repo and commit your changes to the fork.
-
-Here is a preview of what we are expecting:
-
-![Sample](_README_assets/sample.png)
-
-Keep in mind that we may ask you about some of the decisions you made while building the app.
-
-## Important information to complete the challenge
-
-### Data source
-
-Fetch the data from this endpoint [http://www.mocky.io/v2/5ae1c5792d00004d009d7e5c](http://www.mocky.io/v2/5ae1c5792d00004d009d7e5c)
-
-Using Mocky should produce no cross origin errors and should work fine for this challenge. If you do find issues, it's OK to copy the JSON into your preferred method to then provide the data to the app.
-
-### Assets, measurements, and other details
-
-Inside this repository you'll find a folder named `assets-for-challenge`. Inside this folder you can find all the icons we expect you to use, in multiple formats, use what you think is best.
-
-## Detailed comments on each element
-
-![Elements Numbered](_README_assets/challenge-elements-numbered.png)
-
-**Functionality**
-
-The app should let the user do the following:
-
-- **1** - _Get data_ button. When the user **clicks on this button**, your app will **get the data from the URL** in [Data source](#Data source) and fill the list
-- **2** - _Upload data_ button. When the user **clicks on this button**, your app will **make a POST request to the same url** as the _Get data_ button. You should send the latest information on the list using the same structure as you have received it.
-- **3** - _Custom checkbox_. When the user **clicks on the checkbox**, it will become checked. It will not have any other functionality.
-- **4** - _Add line_ button. When the user **clicks on this button**, a **new row will be added to the list** and the user should be able to **write text in both fields**.
-- **5** - _Delete row_ button. This button should be **visible only when hovering** each row item. When the user **clicks on this button**, your app will **remove that row** from the list.
-- **6** - List _item title_ **This title should be editable**.
-- **7** - List _item content_. **This content should be editable**.
-- **8** - _App title_. No functionality.
-- **9** - _Person icon_ linked to each row. No functionality.
-
-Notes:
-
-- Don't worry about the blank state before loading the content.
-
-**Style Attributes**
-
-These are some and useful details about some of the elements
-
-- **3** - The checkbox is 16px wide and 16px high. The purple color is `#859EFF`
-- **6** - The font-family of the _item title_ is `Montserrat`, the weight is `SemiBold`, the size is `16px`, and the color is `#566074`
-- **7** - The font-family of the _item content_ is `Open Sans`, the weight is `Regular`, the size is `16px`, and the color is `#778195`
-- **8** - The font-family of the _app title_ is `Montserrat`, the weight is `Medium`, the size is `18px`, and the color is `#414C5E`
-
-The data above is enough to complete challenge. We also include the source Sketch file in the repository, in case you want to check the original file. You can find it in `_README_assets/Challenge.sketch`
-
-## Typography
-
-- You can find [Montserrat on Google Fonts](https://fonts.google.com/specimen/Montserrat)
-- You can find [Open Sans on Google Fonts](https://fonts.google.com/specimen/Open+Sans)
-
-## Bonus points:
-
-- Keeping in mind accessibility
-- Adding tests to your components and app
-- Using a store (Vuex) to manage the application data
-- Using vue-router to prepare the app for a future where it would have multiple routes
+# frontend-challenge
+
+## Project Setup
+
+```sh
+npm install
+```
+
+### Compile and Hot-Reload for Development
+
+```sh
+npm run dev
+```
+
+### Run Unit Tests with [Vitest](https://vitest.dev/)
+
+```sh
+npm run test:unit
+```
+
+### Run Unit Tests and check its code coverage
+
+```sh
+npm run test:coverage
+```
+
+### Run End-to-End Tests with [Cypress](https://www.cypress.io/)
+
+```sh
+npm run dev
+npm run test:e2e # or `npm run test:e2e:head` for headless testing
+```
+
+## Main features covered
+
+Besides the application itself, below are the features that were also covered during this challenge:
+
+1. **Responsiveness design**: desktop and mobile.
+2. **Accessibility options**: implementation of two modes, _elder mode_ and _color blindness mode_. When the user activates the _elder mode_, the font-size of the application increases. While selecting _color blindness mode_ helps color-blind users to better identify text boxes.
+3. **404 Page**: to illustrate the use of vue-router.
+4. **Empty state page**: to give an indication to the user when there are no transcriptions created.
+5. **Unit testing**.
+6. **E2E testing with Cypress**.
+
+## Notes
+
+### Code coverage result
+
+| File                             | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s |
+| -------------------------------- | ------- | -------- | ------- | ------- | ----------------- |
+| All files                        | 99.77   | 95.65    | 100     | 99.77   |
+| components/accessibility-options | 100     | 100      | 100     | 100     |
+| AccessibilityOptions.vue         | 100     | 100      | 100     | 100     |
+| components/checkbox              | 100     | 100      | 100     | 100     |
+| Checkbox.vue                     | 100     | 100      | 100     | 100     |
+| components/content               | 100     | 100      | 100     | 100     |
+| Content.vue                      | 100     | 100      | 100     | 100     |
+| components/default-page          | 100     | 100      | 100     | 100     |
+| DefaultPage.vue                  | 100     | 100      | 100     | 100     |
+| components/icon-button           | 100     | 100      | 100     | 100     |
+| IconButton.vue                   | 100     | 100      | 100     | 100     |
+| components/input                 | 97.29   | 80       | 100     | 97.29   |
+| Input.vue                        | 97.29   | 80       | 100     | 97.29   | 35-36             |
+| components/layout                | 100     | 100      | 100     | 100     |
+| Layout.vue                       | 100     | 100      | 100     | 100     |
+| components/list-item             | 100     | 100      | 100     | 100     |
+| Item.vue                         | 100     | 100      | 100     | 100     |
+| components/list-item/item-body   | 100     | 100      | 100     | 100     |
+| ItemBody.vue                     | 100     | 100      | 100     | 100     |
+| components/list-item/item-title  | 100     | 100      | 100     | 100     |
+| ItemTitle.vue                    | 100     | 100      | 100     | 100     |
+| components/modal                 | 100     | 100      | 100     | 100     |
+| Modal.vue                        | 100     | 100      | 100     | 100     |
+| components/page-title            | 100     | 100      | 100     | 100     |
+| PageTitle.vue                    | 100     | 100      | 100     | 100     |
+| components/toggle-button         | 100     | 100      | 100     | 100     |
+| ToggleButton.vue                 | 100     | 100      | 100     | 100     |
+| components/top-bar               | 100     | 100      | 100     | 100     |
+| TopBar.vue                       | 100     | 100      | 100     | 100     |
+| shared/utils                     | 100     | 100      | 100     | 100     |
+| accessibilityOptions.js          | 100     | 100      | 100     | 100     |

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:5173",
+	},
+});

cypress/e2e/jsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["es5", "dom"],
+    "types": ["cypress"]
+  },
+  "include": ["./**/*", "../support/**/*"]
+}

cypress/e2e/views/NotFoundView.cy.js

@@ -0,0 +1,35 @@
+describe("NotFoundView", () => {
+	beforeEach(() => {
+		cy.visit("/no/path");
+	});
+
+	it("contains 404 string", () => {
+		// Assert
+		cy.contains(
+			"span",
+			"Ah, the dreaded 404. Let's get you back on track."
+		);
+	});
+
+	it("contains take me home button", () => {
+		// Assert
+		cy.contains("button", "Take Me Home");
+	});
+
+	it("contains accessibility options", () => {
+		// Assert
+		cy.get('[data-test="accessibility-icon"]').should(
+			"have.attr",
+			"alt",
+			"accessibility-icon"
+		);
+	});
+
+	it("should be redirected to home page", () => {
+		// Act
+		cy.contains("button", "Take Me Home").click();
+
+		// Assert
+		cy.url().should("eq", "http://localhost:5173/");
+	});
+});