Skip to content

Update README.md #397

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Update README.md #397

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
219 changes: 90 additions & 129 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,183 +1,144 @@
# Testsigma

[![Latest release](https://img.shields.io/github/v/release/testsigmahq/testsigma)](https://github.com/testsigmahq/testsigma/releases/latest)
[![Docs](https://img.shields.io/badge/docs-latest-brightgreen)](https://testsigma.com/docs)
<a href="https://discord.gg/invite/5caWS7R6QX"><img src="https://img.shields.io/badge/chat-discord-brightgreen.svg?logo=discord&style=flat"></a>
<a href="https://testsigma.com/newsletter"><img src="https://img.shields.io/badge/newsletter-subscribe-yellow.svg?style=flat"></a>


[![Chat on Discord](https://img.shields.io/badge/chat-discord-brightgreen.svg?logo=discord&style=flat)](https://discord.gg/invite/5caWS7R6QX)
[![Subscribe to Newsletter](https://img.shields.io/badge/newsletter-subscribe-yellow.svg?style=flat)](https://testsigma.com/newsletter)

<a href="https://testsigma.com/signup?utm_source=github&utm_medium=social">![testsigma-os-banner](https://docs.testsigma.com/images/github/testsigma-opensource-banner-new.png)</a>
[![Testsigma Open Source](https://docs.testsigma.com/images/github/testsigma-opensource-banner-new.png)](https://testsigma.com/signup?utm_source=github&utm_medium=social)

<p align="center">
<a href="https://testsigma.com/signup?utm_source=github&utm_medium=social" target="_bank">Getting started</a>
<a href="https://testsigma.com/signup?utm_source=github&utm_medium=social" target="_blank">Getting Started</a>
&nbsp; &#8901; &nbsp;
<a href="https://testsigma.com/docs/?utm_source=github&utm_medium=social" target="_bank">Docs</a>
<a href="https://testsigma.com/docs/?utm_source=github&utm_medium=social" target="_blank">Docs</a>
&nbsp; &#8901; &nbsp;
<a href="https://testsigma.com/tutorials/?utm_source=github&utm_medium=social" target="_bank">Tutorials</a>
<a href="https://testsigma.com/tutorials/?utm_source=github&utm_medium=social" target="_blank">Tutorials</a>
&nbsp; &#8901; &nbsp;
<a href="https://github.com/testsigmahq/testsigma/discussions" target="_bank">Discussions</a>
<a href="https://github.com/testsigmahq/testsigma/discussions" target="_blank">Discussions</a>
&nbsp; &#8901; &nbsp;
<a href="https://discord.com/invite/5caWS7R6QX" target="_bank">Discord</a>
<a href="https://discord.com/invite/5caWS7R6QX" target="_blank">Discord</a>
&nbsp; &#8901; &nbsp;
<a href="https://www.youtube.com/testsigma" target="_bank">YouTube</a>
<a href="https://www.youtube.com/testsigma" target="_blank">YouTube</a>
</p>
&emsp;
&emsp;
&emsp;

## Overview
Testsigma is an open-source, extensible test automation platform that works out of the box. Rapidly(5X faster) automate web, mobile app, and API tests in plain English.
- Eliminate complex setups, multiple tools and frameworks.
- Let everyone write tests 5X faster using plain English.
- Smart test recorder auto-converts user actions into editable steps.
- Automate end-to-end testing for web, mobile apps & APIs.
- Minimal to no maintenance of tests and frameworks
- Built-in test data management for parameterized testing
- Seamless integrations with CI/CD, bug reporting, product management tools, & collaboration tools & test labs for continuous testing.
- Extend the platform with 100+ pre-built add-ons (for custom actions, data generators, integrations) or build your own with Testsigma SDKs.

Testsigma is an open-source, extensible test automation platform that works out of the box. Automate web, mobile app, and API tests in plain English 5× faster.

### Key Features
- No complex setups or multiple tools.
- Write human-readable tests in plain English.
- Auto-convert user actions into editable test steps.
- End-to-end testing for web, mobile apps & APIs.
- Minimal maintenance of tests and frameworks.
- Built-in test data management.
- Seamless CI/CD, bug tracking, and product management integrations.
- Extend the platform with 100+ pre-built add-ons or create your own.

[![Testsigma Overview](https://docs.testsigma.com/images/github/banner-video.png)](https://docs.testsigma.com/videos/testsigma-overview.mp4)

## Quick Start: One-Click Deployment on Testsigma Cloud

## **Quick start: One click deployment on Testsigma Cloud**

The easiest way to start your automation journey is with Testsigma Cloud.

Get started quickly with Testsigma Cloud.

<a href="https://testsigma.com/signup?utm_source=github&utm_medium=social" target="_blank">
<img src="https://docs.testsigma.com/images/github/deploy-2-testsigma-cloud.svg?1234" width="30%" alt="How to automate testing with Testsigma" /></a>

<br/>
<br/>
Once you deploy, you can follow the below tutorials to get started
<img src="https://docs.testsigma.com/images/github/deploy-2-testsigma-cloud.svg?1234" style="max-width: 200px; height: auto;" alt="Automate testing with Testsigma" />
</a>

Once deployed, follow these tutorials:
- [Automating Web Applications](https://testsigma.com/tutorials/getting-started/automate-web-applications/)
- [Automating Mobile Web Applications](https://testsigma.com/tutorials/getting-started/automate-mobile-web-applications/)
- [Automating iOS Apps](https://testsigma.com/tutorials/getting-started/automate-android-applications/)
- [Automating Android Apps](https://testsigma.com/tutorials/getting-started/automate-ios-applications/)
- [Automating Android Apps](https://testsigma.com/tutorials/getting-started/automate-android-applications/)
- [Automating iOS Apps](https://testsigma.com/tutorials/getting-started/automate-ios-applications/)
- [Automating REST API Testing](https://testsigma.com/tutorials/getting-started/automate-rest-apis/)

## **Other deployment options**
We have 2 more deployment options to choose from

1. [Using Docker](https://testsigma.com/docs/getting-started/setup/docker/)
2. [Using Downloadable Package](https://testsigma.com/docs/getting-started/setup/downloadable-package/)
## Other Deployment Options
- [Using Docker](https://testsigma.com/docs/getting-started/setup/docker/)
- [Using Downloadable Package](https://testsigma.com/docs/getting-started/setup/downloadable-package/)

## **Features**
## Features

#### Test Development
- Write code-agnostic, human-readable tests in plain English.
- Generate airtight test scripts for web and mobile apps using Test Recorder.
- Integrate automated API calls within your functional/UI test steps.
### Test Development
- Write code-free, human-readable tests.
- Auto-generate test scripts with the built-in recorder.
- Integrate API calls within functional/UI test steps.

#### Data-Driven/Parameterized Testing
- Upload test data sets as (XLS) files or create within Testsigma.
- Use built-in data generators for mock test data.
- Create your own custom data generators as add-ons.
### Data-Driven Testing
- Upload test data (XLS) or create it within Testsigma.
- Use built-in data generators or create custom ones.

#### Results & Reports
- Debug using screenshots, videos, text logs, and more.
- Generate custom reports at test, module, test suite, and device/system levels.
### Results & Reports
- Debug with screenshots, videos, and logs.
- Generate reports at test, module, and suite levels.

#### Integrations
- Integrate with any CI tool to run regression tests at every build.
- Integrate with Collaboration tools, Bug Reporting tools, Product Management tools, Cloud based Test Labs
### Integrations
- CI/CD, bug tracking, and cloud testing integrations.
- Collaboration and product management tool support.

#### Unified Platform
- Automate Web, Mobile Web, Android, iOS apps, and API testing using one platform
### Unified Platform
- Automate Web, Mobile Web, Android, iOS, and API tests.

#### Visual Testing
- Enable visual testing with a toggle while creating a test plan.
### Visual Testing
- Enable visual testing while creating a test plan.

[See more on our website](https://testsigma.com)

## **Build & extend the platform with Add-ons**

Add-ons are custom extensions built and shared by the Testsigma Community at the [Add-ons Marketplace](https://testsigma.com/addons). Add-ons are built to automate unique user actions and test automation scenarios that are not possible with Testsigma’s default actions.

You can build your own add-on using Testsigma SDK.

#### **Types of add-ons supported in Testsigma**

- **Custom Actions:** Testsigma provides a set of comprehensive, built-in addons that lets you automate most user actions in simple English. But sometimes you may need to automate actions unique to your AUT. For this, you can build custom add-ons to automate unique actions. See: [How to build a custom action in add-ons.](https://testsigma.com/tutorials/addons/how-create-addons-actions/)
## Extend with Add-ons

- **Custom Data Generators:** Testsigma contains [default Data Generators](https://testsigma.com/docs/test-data/data-generators/defalut-list/) to generate instant test data for your automation scenarios. You can also build custom data generators. See: [How to build a custom data generator.](https://testsigma.com/tutorials/addons/how-create-addons-test-data-generators/)
Extend Testsigma with custom add-ons built by the community.

- **Conditional If:** You can create an action to execute a sequence of steps if the condition is matched. You can write your own logic for the conditional if. See: [How to add conditional if actions.](https://testsigma.com/tutorials/addons/how-create-addons-conditional-if/)
### Types of Add-ons
- **Custom Actions:** Automate unique actions beyond built-in commands.
- **Custom Data Generators:** Generate specialized test data.
- **Conditional If:** Execute steps based on conditions.
- **While Loops:** Repeat steps until a condition is met.

Learn more:
- [How to build a custom action](https://testsigma.com/tutorials/addons/how-create-addons-actions/)
- [How to create a custom data generator](https://testsigma.com/tutorials/addons/how-create-addons-test-data-generators/)
- [How to add conditional logic](https://testsigma.com/tutorials/addons/how-create-addons-conditional-if/)
- [How to add while loops](https://testsigma.com/tutorials/addons/how-create-addons-while-loops/)

- **While Loops:** You can create an action to execute a sequence of steps until the condition is matched. You can write your own logic for the conditional if. See: [How to add while actions.](https://testsigma.com/tutorials/addons/how-create-addons-while-loops/)
## Tutorials
Explore more Testsigma tutorials:

## **Tutorials**
1. [Automating Web Applications](https://testsigma.com/tutorials/getting-started/automate-web-applications/)
2. [Automating Mobile Web Applications](https://testsigma.com/tutorials/getting-started/automate-mobile-web-applications/)
3. [Automating Android Apps](https://testsigma.com/tutorials/getting-started/automate-android-applications/)
4. [Automating iOS Apps](https://testsigma.com/tutorials/getting-started/automate-ios-applications/)
5. [REST API Testing](https://testsigma.com/tutorials/getting-started/automate-rest-apis/)

Here are the latest tutorials and videos for you to learn more about Testsigma:
Visit our [tutorials page](https://testsigma.com/tutorials/) for more.

1. [Get Started with Automating Web Applications](https://testsigma.com/tutorials/getting-started/automate-web-applications/)
2. [Get Started with Automating Mobile Web Applications](https://testsigma.com/tutorials/getting-started/automate-mobile-web-applications/)
3. [Get Started with Automating Android Apps](https://testsigma.com/tutorials/getting-started/automate-android-applications/)
4. [Get Started with Automating iOS Apps](https://testsigma.com/tutorials/getting-started/automate-ios-applications/)
5. [Get Started with REST API Testing](https://testsigma.com/tutorials/getting-started/automate-rest-apis/)
6. [How to create web application tests using Test Recorder](https://testsigma.com/tutorials/test-cases/web-apps/build-tests-using-recorder/)
7. [How to create Android & iOS app tests using Test Recorder](https://testsigma.com/tutorials/test-cases/mobile-apps/build-tests-using-recorder/)
8. [How to automate Android app tests using local devices](https://testsigma.com/tutorials/test-cases/mobile-apps/build-tests-using-local-android-devices/)
9. [How to automate iOS app tests using local devices](https://testsigma.com/tutorials/test-cases/mobile-apps/build-tests-using-local-ios-devices/)
10. [How to automate data driven testing](https://testsigma.com/tutorials/test-cases/data-driven-testing/)
11. [How to create Addons for automated actions](https://testsigma.com/tutorials/addons/how-create-addons-actions/)
12. [How to create a test data generator in Addons](https://testsigma.com/tutorials/addons/how-create-addons-test-data-generators/)
13. How to automate Two-factor authentication testing (Email & SMS)
## Roadmap
See our [roadmap](https://testsigma.com/docs/product-updates/roadmap/) to check upcoming features.

Visit our [tutorials](https://testsigma.com/tutorials/) to explore more.
## Support & Troubleshooting

- 💬 [Join our Discord](https://discord.com/invite/5caWS7R6QX)
- 📚 [Read our Docs](https://testsigma.com/docs/)
- 🐛 [Report Issues](https://github.com/testsigmahq/testsigma/issues)
- 👾 [Community Forum](https://github.com/testsigmahq/testsigma/discussions)
- 💬 [Live Chat](https://testsigma.com/)

## **Roadmap**
Please review our [Code of Conduct](CODE_OF_CONDUCT.md) and [Security Policy](SECURITY.md).

Check out our [roadmap](https://testsigma.com/docs/product-updates/roadmap/) to see what we are or will be working on.
## Join Our Community

## **Support & Troubleshooting**
Engage with testers, developers, and automation architects worldwide. Join the [Testsigma Community on Discord](https://discord.com/invite/5caWS7R6QX).

The documentation and community will help you troubleshoot most issues. If you have encountered a bug, you can contact us using one of the following channels:
## Stay Up to Date

- 💬 Support & feedback: [Discord](https://discord.com/invite/5caWS7R6QX)
- :books: Find a solution in our [Documentation](https://testsigma.com/docs/)
- :bug: Issue & bug tracking: [GitHub issues](https://github.com/testsigmahq/testsigma/issues)
- 👾 Ask for help on our [Forum](https://github.com/testsigmahq/testsigma/discussions)
- 💬 Talk to us on our [website chat](https://testsigma.com/)
Sign up for our [monthly newsletter](https://testsigma.com/whats-new) to get the latest updates.

We are committed to fostering an open and welcoming environment in the community. Please see the [Code of Conduct](CODE_OF_CONDUCT.md).
## Contribute

If you want to report a security issue, please [read this](SECURITY.md).

## **Join our community**

Engage with test automation Architects, SDETs, Testers, and Developers around the world. Get the latest product updates. Discuss testing philosophies and more. Join the [Testsigma Community on Discord](https://discord.com/invite/5caWS7R6QX).


## **Stay up to date**

We release new features every month. Sign up for our newsletter by using the link below. We send newsletters only once a month.

https://testsigma.com/whats-new


## **Contribute**

We love our contributors! If you'd like to contribute anything from a bug fix to a feature update, start here:

- 📖 Read our [Contribution Guide](CONTRIBUTING.md)
We welcome contributions! Start here:
- 📖 [Contribution Guide](CONTRIBUTING.md)
- 🧩 [Set up your local environment](https://testsigma.com/docs/contributing/setup-dev-environment/)
- 👾 Explore some [good first issues](https://github.com/testsigmahq/testsigma/issues)
- 📕 Read our [Code of Conduct](CODE_OF_CONDUCT.md)

## **Launching Testsigma Rewards**
Contributed to Testsigma? Here is a big thank you from our community to you.
Claim your badge and showcase them with pride.
Let us inspire more folks !

![Testsigma Badges](https://aviyel.com/assets/uploads/rewards/share/project/50/512/share.png)
### **[Claim Now!](https://aviyel.com/projects/50/testsigmahq/rewards)**
- 👾 [Good first issues](https://github.com/testsigmahq/testsigma/issues)
- 📕 [Code of Conduct](CODE_OF_CONDUCT.md)

## **License**
## License

Testsigma is available under the [Apache License 2.0](LICENSE) (Apache-2.0).
Testsigma is available under the [Apache License 2.0](LICENSE).