Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/documente/documente

A literate testing framework to generate automated tests from documentation files
https://github.com/documente/documente

automated-testing cypress documentation-tool end-to-end-testing literate-testing playwright

Last synced: about 1 month ago
JSON representation

A literate testing framework to generate automated tests from documentation files

Awesome Lists containing this project

README

        



Logo for the Documenté literate testing framework

Welcome to Documenté


The Javascript literate testing framework

> Visit [Documenté's website](https://documente.github.io) for an overview of the framework!

## Repository overview

This monorepository contains the core components of the Documenté framework.

| Package name | Description |
| ------------ | ----------- |
| [generator](./packages/generator) | Extracts Phrasé tests from documentation files and generate test cases |
| [kitchen-sink](./packages/kitchen-sink) | A static website with Documenté configuration showcasing the API |
| [minimal-example](./packages/minimal-example) | An example of a Documenté configuration to run tests against example.com |
| [phrase](./packages/phrase) | The Phrasé language parser |
| [runner-cypress](./packages/runner-cypress) | Test runner for Cypress |
| [runner-playwright](./packages/runner-playwright) | Test runner for Playwright |

## Getting started

See the [Getting Started guide](https://documente.github.io/getting-started.html).

## Contributing

Any contributions you make are _greatly appreciated_.

For suggestions and improvements, feel free to fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!

## License

Distributed under the GNU GPL3 License.

See `LICENSE` for more information.

## Contact

Pierre-Clément KERNEIS - [email protected]

Project Link: https://github.com/documente