@restqa/restqa/README.md

An all in one test automation runner

<p align="center">
  <a href="https://restqa.io" target="_blank" rel="noopener noreferrer">
    <img src="https://restqa.io/assets/img/logos/restqa-logo-colors.png" alt="RestQA logo" width="180"/>
  </a>
</p>
<br/>
<p align="center">
  <a href="https://www.npmjs.com/package/@restqa/restqa"><img src="https://img.shields.io/npm/v/@restqa/restqa" alt="npm package"></a>
  <a href="https://nodejs.org/en/about/releases/"><img src="https://img.shields.io/node/v/@restqa/restqa" alt="node compatility"></a>
  <a href="https://github.com/restqa/restqa/actions/workflows/build.yml"><img src="https://github.com/restqa/restqa/actions/workflows/build.yml/badge.svg" alt="github action build"></a>
  <a href="https://hub.docker.com/r/restqa/restqa"><img src="https://img.shields.io/docker/v/restqa/restqa/latest" alt="Docker build"></a>
  <a href="https://restqa.io/chat"><img src="https://img.shields.io/badge/chat-discord-blue?style=flat&logo=discord" alt="discord chat"></a>
</p>
<br/>

# RestQA 🦏

> Next Generation End-to-End API test automation platform

- 🚀 Instant installation
- 🤩 low learning curve
- ⭐️ 100+ built-in feature steps
- 🔌 Dozen of integrations
- 🕵️ Data privacy focused


[RestQA](https://restqa.io) was born from a need of getting more transparency of a product behavior. It consists of two major parts:

- Use Gherkin to enforce the ATDD (acceptance test driven development) as pratice across the team member regardless of their background

- Reuse the team toolset as maximum, in order to reduce the learning curve and focus on the product behavior test scenario

In addition, RestQA is highly extensible via its [Plugin API](https://docs.restqa.io/api/plugin-api) and [Output API](https://docs.restqa.io/api/output-api).

[Read the Docs to Learn More](https://docs.restqa.io).

### Demo

[<img src="https://restqa.io/assets/img/utils/video-600.png" width=600 />](https://www.youtube.com/watch?v=EberYFGPZPo)

[Access to the Youtube Video](https://www.youtube.com/watch?v=EberYFGPZPo)

### Example

Take a look at the [example folder](./example) to see a basic setup.

More example available on the [restqa-example](https://github.com/restqa/restqa-example) repository.

## Contribution

See [Contributing Guide](./CONTRIBUTING.md).

## License

[MIT License](./LICENSE)