devtool-ui-tester's Introduction

DevTool UI Tester

Open-source developer tool that provides a simple way to ensure compatibility of React Projects across different Node environments using Yarn or NPM using GitHub Actions.

Product Features

✅ Supports multiple React Kits as input
✅ Multiple NodeJS versions
✅ Builders: Yarn, NPM, or both
✅ Report provided for each test combination
✅ MIT license
✅ Free support provided by AppSeed

✨ How it works

Complete presentation: how to test external kits and fork the project

React.Products.-.Automatic.Compatibility.Tests.in.Different.Environments.using.GH.Actions.mp4

✨ How to use it

👉 Fork the project
👉 Edit repositories.json and add your projects to test
👉 Edit compatibility.yaml and specify the Node verison
- multiple values supported: node-version: [16.x, 18.x]
👉 Edit the builder in report-test-build.sh
- Yarn or NPM

✨ Installation

The compatibily check is run against the repositories in the repositories.json file. The file is located in the root of the repository.

To add a new repository, add a new entry to the repositories.json file.

{
    "repositories": [{
            "repoURL": "https://github.com/app-generator/react-datta-able.git"
        },
        {
            "repoURL": "https://github.com/app-generator/react-berry-dashboard.git"
        },
        {
            "repoURL": "YOUR_REPOSITORY_GIT_URL"
        }
    ]
}

✨ Automated Testing using GH Actions

The ui test tool can be run using GH actions. Using Github Actions, you benefit from parallel builds on different nodejs environment.

...
jobs:
  compatibility-check:
    name: Compatibility Check
    runs-on: ubuntu-20.04
    continue-on-error: true

    strategy:
      matrix:
        node-version: [10.x, 12.x, 14.x, 16.x, 18.x]
 ...