Skip to content
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

Center Readme Image #2

Merged
merged 2 commits into from
Oct 4, 2019
Merged

Center Readme Image #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
48b0e44
Center Readme Image
hipstersmoothie Oct 4, 2019
977ff73
add some pizaz
hipstersmoothie Oct 4, 2019
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
31 changes: 20 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
# ReplayWeb

![Logo](packages/extension/extension/logo.png)
<div align="center">
<img width="200" height="200"
src="./packages/extension/extension/logo.png">
<h1>ReplayWeb</h1>
<p>All-in-one toolbox for generating browser automation</p>
</div>

<!-- TODO badges -->

ReplayWeb is a all-in-one toolbox that allows developers to focus on writing and maintaining application code, not test code. It is comprised of a Chrome extension that you install in your Chrome browser that allows you to record test scripts and saved and played back later. Once you have recorded scripts you can play them back from within the extension or on the command line. The command line execution uses the ReplayWeb Test Runner to automatically convert tests to WebDriverIO scripts that can be played back across different browsers.

### Feature highlights

* Easy script recording via a Chrome extension
* Ability to execute recorded tests locally via Chrome extension or command line
* Integration with source code repositories to enable running tests during CI/CD
:rocket: Easy script recording via a Chrome extension

:rocket: Ability to execute recorded tests locally via Chrome extension or command line

:rocket: Integration with source code repositories to enable running tests during CI/CD

## Getting Started with ReplayWeb

Expand All @@ -36,8 +41,8 @@ yarn add -D @replayweb/testrunner @wdio/cli @wdio/local-runner @wdio/junit-repor
And add a simple `wdio.conf.js`:

```js
const { getDefaults, loadFromConfig } = require('@replayweb/testrunner')
exports.config = { ...getDefaults(), ...loadFromConfig() }
const { getDefaults, loadFromConfig } = require('@replayweb/testrunner');
exports.config = { ...getDefaults(), ...loadFromConfig() };
```

This will read the `replay.config.json` from your repository, that was created by the Chrome extension and load all of your tests and suites. To execute the tests in your shell you can do `npx wdio`, or add a script to `package.json` that just executes `wdio`.
Expand All @@ -47,21 +52,25 @@ For additional details see the [readme](packages/testrunner/README.md) for the T
## Documentation

The documentation is divided into several sections:
* [Chrome Extension](packages/extension/README.md)
* [Test Runner](packages/testrunner/README.md)
* See full list of documentation [here](packages/)

- [Chrome Extension](packages/extension/README.md)
- [Test Runner](packages/testrunner/README.md)
- See full list of documentation [here](packages/)

## Contributing

Read below to learn how you can take part in improving ReplayWeb.

### Code of Conduct

Intuit has adopted a Code of Conduct that we expect project participants to adhere to. Please read the [full text](.github/CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.

### Contributing Guide

Thanks for your interest! Please see the [CONTRIBUTING.md](.github/CONTRIBUTING.md) file for more information on how to develop and test your changes before contributing bug fixes and enhancements for ReplayWeb.

### Good First Issues

To help you get your feet wet with our contribution process, we have a list of [good first issues](https://github.com/intuit/replayweb/labels/good%20first%20issue) that have a relatively limited scope. This is a great place to get started.

## License
Expand Down