Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Bamieh committed Sep 30, 2018
1 parent ee7e719 commit 2ea4cfc
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 9 deletions.
29 changes: 20 additions & 9 deletions README.md
@@ -1,5 +1,5 @@
<p align="center">
<img alt="reflow logo" src="https://github.com/Bamieh/reflow/raw/master/reflow.png" width="230" height="80" />
<img alt="reflow logo" src="https://github.com/Bamieh/reflow/raw/master/reflow.png?v=1" width="230" height="80" />
</p>

<p align="center">
Expand Down Expand Up @@ -31,24 +31,35 @@ $ npm run lerna:bootstrap

<p align="center">
<a href="#reflow-architecture">
<img alt="reflow architecture" src="https://github.com/Bamieh/reflow/raw/master/reflow_arch.png" />
<img alt="reflow architecture" src="https://github.com/Bamieh/reflow/raw/master/reflow_arch.png?v=1" />
</a>
</p>

### Components

Reflow is made to work at scale. Each individual component of the framework is designed to work in a distributed environment and scale individually.

- reflow|core: a wrapper on top of mocha, connects to the client, provides test flows, and manages multi-flows to run across devices or in multi-threads.
- reflow|cli: the command line interface to run the e2e project.
- reflow|client: provides the client api of the connected device.
- reflow|grid: connects and manages devices. currently uses selenium hub.
- reflow|reporter: a custom mocha reported used to report to the reflow|board.
Board:
- reflow|board: a board to display e2e projects, jobs, flows, and test results.

Hub:
- reflow|grid: connects and manages devices. currently uses selenium hub.

Client Nodes:
- reflow|appium: a wrapper around appium to discover and connect iOS and android devices to reflow|grid.

Storage:
- reflow|cassandra-connection: express middleware to persist test results to Cassandra.

Circuit:
- reflow|circuit: an express middleware providing graphQL api to query and save test results.

E2E Project:
- reflow|core: a wrapper on top of mocha, connects to the client, provides test flows, and manages multi-flows to run across devices or in multi-threads.
- reflow|reporter: a custom mocha reporter for running projects.
- reflow|page-objects: manage page objects in e2e projects.
- reflow|cassandra-connection: express middleware to persist test results to Cassandra.
- reflow|appium: a wrapper around appium to discover and connect iOS and android devices to reflow|grid.
- reflow|cli: the command line interface to run the e2e project.
- reflow|client: provides the client api of the connected device.


## License
Expand Down
Binary file modified reflow_arch.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2ea4cfc

Please sign in to comment.