Skip to content

charleslana/automationsy

Repository files navigation

AutomationSy Documentation

💡 Introduction

This documentation is in 🇺🇸 English, however the Portuguese documentation from 🇧🇷 Brazil is available by clicking here

AutomationSy is a test automation tool dedicated to QA.

However, the lib is only focused on automating tests dealing with page elements and actions with high speed.

AutomationSy has puppeteer as its core or dependency, in which it can connect with the browser and carry out interactions through a very extensive coding. Unlike puppeteer, AutomationSy becomes a solution that the user who is programming the tests, has less code effort and faster coding scenarios.


💾 Installation

Just clone the project or download the project to your environment.

git clone https://github.com/charleslana/automationsy.git

🔧 Initial setup

Node installed required

Run the installation of dependencies

npm i

📄 Detailed documentation/API

You can access the documentation site here


📝 How to create my tests?

const { Action, Config, Resource } = require('automationsy');

(async () => {
  Config.setHeadless(true);
  await Action.navigate('https://github.com/charleslana');
  await Resource.getText('.vcard-fullname');
  await Action.closeBrowser();
})();

⏱️ Running the tests

Javascript

node test.js

Typescript

tsc && node build/test.js

📌 Which operating system does it support?

It has been tested on Linux only, you can test to see if it works on other OS.


💪 Contribution

Since the project is free to use as per the license, you can contribute new ideas and improvements, stay free to comment, fork, create a pull request, or open an issue.

Contributions are always welcome!

See CONTRIBUTING.md for how to get started.

Please follow the CODE_OF_CONDUCT.md of this project.


🎥 Demo

Access the demo recorder and use YouTube


📄 License

GPLv3 License


📢 Author