From b0a91c91e8b9f146f872967544242363e8f2c4e3 Mon Sep 17 00:00:00 2001 From: leejooy96 Date: Tue, 27 Jun 2023 11:21:34 +0900 Subject: [PATCH] docs: update `README.md` and add testing documentation --- README.md | 4 +++- docs/src/automated-testing.md | 11 +++++++++++ 2 files changed, 14 insertions(+), 1 deletion(-) create mode 100644 docs/src/automated-testing.md diff --git a/README.md b/README.md index b3b3f0d..184436f 100644 --- a/README.md +++ b/README.md @@ -22,11 +22,13 @@ Quick Start Templates for **[Vite](https://vitejs.dev)** + **[Vue 3](https://vue - ⚡️ Rapid development through hot-reload - ⚡️ Cross-platform development and build support +- ⚡️ Support for automated application testing +- ⚡️ TypeScript support - ⚡️ Multilingual support - ⚡️ Support for themes (dark & light) - ⚡️ Basic layout manager - ⚡️ Global state management through the Pinia store -- ⚡️ TypeScript support +- ⚡️ Quick support through the GitHub community and official documentation ## [Getting Started & Documentation](https://vutron.jooy2.com) diff --git a/docs/src/automated-testing.md b/docs/src/automated-testing.md new file mode 100644 index 0000000..8efbfcc --- /dev/null +++ b/docs/src/automated-testing.md @@ -0,0 +1,11 @@ +# Automated Testing + +**Vutron** includes automated testing. The testing framework uses Microsoft's **[Playwright](https://playwright.dev)**. + +**Playwright** is optimized for web application testing and has full support for the **Electron** framework. It is simple to install, requires no configuration to start testing immediately, and is cross-platform. You can learn more about **Playwright** here: https://github.com/microsoft/playwright + +Only very simple launch and behavioral tests for the template main screen have been implemented in this template. Advanced testing will depend on the scope of your application. + +Currently, the test specification file is located in the `tests` directory and the test results file is located in `tests/results`. (The built-in test specification file does not generate a separate results file.) + +The Playwright configuration is `playwright.config.ts` in the project root, see the following documentation for more information on this: https://playwright.dev/docs/test-configuration