From 059df7d33693b82dc40021f57ef7823f87cdd9e0 Mon Sep 17 00:00:00 2001 From: patrick Date: Mon, 21 Oct 2024 14:50:37 +0800 Subject: [PATCH] change README --- README.md | 158 +---------------- docs/1-qa-solution/README.md | 163 ++++++++++++++++++ .../1-qa-solution/libs-concept.png | Bin overall.png => docs/1-qa-solution/overall.png | Bin 4 files changed, 172 insertions(+), 149 deletions(-) create mode 100644 docs/1-qa-solution/README.md rename libs-concept.png => docs/1-qa-solution/libs-concept.png (100%) rename overall.png => docs/1-qa-solution/overall.png (100%) diff --git a/README.md b/README.md index 5ec69f6..a8d0e4f 100644 --- a/README.md +++ b/README.md @@ -1,158 +1,18 @@ # README -This Project is the answer to : +JAVA Solutions not only for QA but also for anyone want to build backoffice solution just in days. -``` -接口自动化测试平台需求： -1、可对接 swagger 文档，自动/手动导入接口信息 -2、具备接口信息管理、测试用例管理、测试步骤管理、测试报告管理的功能 -3、具备接口调试的功能 -4、以测试集为单位执行多个测试用例，并生成测试报告 +Features: -API Automation Testing Platform Requirements: +- [Base Libs](https://github.com/fluent-qa/fluentqa-workspace/tree/feat/base) built-in libs for JAVA application +- [qa-solutions](https://github.com/fluent-qa/fluentqa-workspace/tree/feat/qa) QA backup office solution include: + - Test Case Management + - API Spec Management + - Test Data Management + - Test Scenarios management +- [feeds](https://github.com/fluent-qa/fluentqa-workspace/tree/feat/feeds) getting different feeds from github or any others -1. Capable of integrating with Swagger documentation, with the ability to automatically/ manually import interface information. -2. with functions for managing interface information, test case management, test step management, and test report management. -3. Possesses the capability for interface debugging. -4. Executes multiple test cases as a test suite and generates test reports. -``` -Build A [restack](https://www.restack.io/) like toolkits but for Software QA. - - -## Features - - - -FluentQA Workspace project is JAVA Project includes: - -1. Toolkits to handler QA Daily Work -2. Workspace Server for QA Daily Work -3. Learning JAVA in QA perspective -4. Revisited JAVA after A QA writing JAVA several years -5. Easy to Use, Maintain and extend -6. All Codes are Used for Real Cases -7. All libs have its purpose in QA Daily Work - -But Actually not only for QA, it also for anyone want to create -JAVA Libs or Applications. - -## 1. Software QA: JAVA Revisited Overview - -**Automation Language Perspective**: -![img](qa-automation.png) - -**Different Libs Perspective**: - -![img](overall.png) - -## 1.1 QA Java frequent used libs - -- [basic-libs](./components/fluent-builtin) basic JAVA Utils -- [excel-csv-operation](./components/fluent-excel) JAVA Excel/CSV Lib -- [mindmap-operation](./components/fluent-mindmap) JAVA mindmap Lib -- [openapi-operations](./components/fluent-openapi) JAVA openapi lib -- [quick-database-operations](./components/fluent-quickdao) JAVA Database access Lib -- [markdonw-operations](./components/fluentqa-md) JAVA Markdown Lib -- [testlibs](./components/fluent-testlibs) JAVA test libs - -### 2. Real Cases - -## 2.1. How to Build a Just-Working Test Case System in one day - -- [slides](https://fluentqa-revistied.netlify.app/present/tc-mgt-one-day/#/1) - -## 3. Integration Libs - -- [integration with other application](http://github.com/fluent-qa/fluent-integrations.git) - -## stats - -[//]: # (

) - -[//]: # ( ) - -[//]: # ( IHub) - -[//]: # ( IHub) - -[//]: # ( ) - -[//]: # (

) - ---- - -[//]: # (

) - -[//]: # ( ) - -[//]: # ( CII Best Practices Level) - -[//]: # ( ) - -[//]: # ( ) - -[//]: # ( Gradle Build) - -[//]: # ( ) - -[//]: # ( ) - -[//]: # ( Space Metric) - -[//]: # ( ) - -[//]: # ( ) - -[//]: # ( CodeFactor) - -[//]: # ( ) - -[//]: # ( ) - -[//]: # ( Codecov) - -[//]: # ( ) - -[//]: # ( ) - -[//]: # ( IHubPub) - -[//]: # ( ) - -[//]: # ( ) - -[//]: # ( IHubPub) - -[//]: # ( ) - -[//]: # ( ) - -[//]: # ( Gitter) - -[//]: # ( ) - -[//]: # ( ) - -[//]: # ( Java Doc) - -[//]: # ( ) - -[//]: # ( ) - -[//]: # ( IHub Snapshot Repository) - -[//]: # ( ) - -[//]: # ( ) - -[//]: # ( Maven Central) - -[//]: # ( ) - -[//]: # (

) - -[//]: # (组件库) ## 🧭 开源贡献指南 diff --git a/docs/1-qa-solution/README.md b/docs/1-qa-solution/README.md new file mode 100644 index 0000000..27f66f0 --- /dev/null +++ b/docs/1-qa-solution/README.md @@ -0,0 +1,163 @@ +# README + +This Project is the answer to : + +``` +接口自动化测试平台需求： +1、可对接 swagger 文档，自动/手动导入接口信息 +2、具备接口信息管理、测试用例管理、测试步骤管理、测试报告管理的功能 +3、具备接口调试的功能 +4、以测试集为单位执行多个测试用例，并生成测试报告 + +API Automation Testing Platform Requirements: + +1. Capable of integrating with Swagger documentation, with the ability to automatically/ manually import interface information. +2. with functions for managing interface information, test case management, test step management, and test report management. +3. Possesses the capability for interface debugging. +4. Executes multiple test cases as a test suite and generates test reports. +``` + +Build A [restack](https://www.restack.io/) like toolkits but for Software QA. + + +## Features + + + +FluentQA Workspace project is JAVA Project includes: + +1. Toolkits to handler QA Daily Work +2. Workspace Server for QA Daily Work +3. Learning JAVA in QA perspective +4. Revisited JAVA after A QA writing JAVA several years +5. Easy to Use, Maintain and extend +6. All Codes are Used for Real Cases +7. All libs have its purpose in QA Daily Work + +But Actually not only for QA, it also for anyone want to create +JAVA Libs or Applications. + +## 1. Software QA: JAVA Revisited Overview + +**Automation Language Perspective**: +![img](qa-automation.png) + +**Different Libs Perspective**: + +![img](docs/1-qa-solution/overall.png) + +## 1.1 QA Java frequent used libs + +- [basic-libs](./components/fluent-builtin) basic JAVA Utils +- [excel-csv-operation](./components/fluent-excel) JAVA Excel/CSV Lib +- [mindmap-operation](./components/fluent-mindmap) JAVA mindmap Lib +- [openapi-operations](./components/fluent-openapi) JAVA openapi lib +- [quick-database-operations](./components/fluent-quickdao) JAVA Database access Lib +- [markdonw-operations](./components/fluentqa-md) JAVA Markdown Lib +- [testlibs](./components/fluent-testlibs) JAVA test libs + +### 2. Real Cases + +## 2.1. How to Build a Just-Working Test Case System in one day + +- [slides](https://fluentqa-revistied.netlify.app/present/tc-mgt-one-day/#/1) + +## 3. Integration Libs + +- [integration with other application](http://github.com/fluent-qa/fluent-integrations.git) + +## stats + +[//]: # (

) + +[//]: # ( ) + +[//]: # ( IHub) + +[//]: # ( IHub) + +[//]: # ( ) + +[//]: # (

) + +--- + +[//]: # (

) + +[//]: # ( ) + +[//]: # ( CII Best Practices Level) + +[//]: # ( ) + +[//]: # ( ) + +[//]: # ( Gradle Build) + +[//]: # ( ) + +[//]: # ( ) + +[//]: # ( Space Metric) + +[//]: # ( ) + +[//]: # ( ) + +[//]: # ( CodeFactor) + +[//]: # ( ) + +[//]: # ( ) + +[//]: # ( Codecov) + +[//]: # ( ) + +[//]: # ( ) + +[//]: # ( IHubPub) + +[//]: # ( ) + +[//]: # ( ) + +[//]: # ( IHubPub) + +[//]: # ( ) + +[//]: # ( ) + +[//]: # ( Gitter) + +[//]: # ( ) + +[//]: # ( ) + +[//]: # ( Java Doc) + +[//]: # ( ) + +[//]: # ( ) + +[//]: # ( IHub Snapshot Repository) + +[//]: # ( ) + +[//]: # ( ) + +[//]: # ( Maven Central) + +[//]: # ( ) + +[//]: # (

) + +[//]: # (组件库) + +## 🧭 开源贡献指南 + +## 👨‍💻 Contributors + +![Alt](https://repobeats.axiom.co/api/embed/97e9207fda40115a8deccefedc421fa84d02eb17.svg "Repobeats analytics image") + +[//]: # ([![Contributors](https://contrib.rocks/image?repo=ihub-pub/libs)](https://github.com/ihub-pub/libs/graphs/contributors "Contributors")) \ No newline at end of file diff --git a/libs-concept.png b/docs/1-qa-solution/libs-concept.png similarity index 100% rename from libs-concept.png rename to docs/1-qa-solution/libs-concept.png diff --git a/overall.png b/docs/1-qa-solution/overall.png similarity index 100% rename from overall.png rename to docs/1-qa-solution/overall.png