Skip to content

Commit

Permalink
docs: Desktop POC SDD (#1709)
Browse files Browse the repository at this point in the history
  • Loading branch information
piotradamczyk5 authored Mar 18, 2021
1 parent f32ae8b commit 6528ab5
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions docs/desktop/flank_desktop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Flank desktop prototype

## Prototype Flank options

The prototype will run a simple Android test on a given apk and test the apk with options to specify some flanks flags, as well
as max tests shards. Those flags are the most popular one based on [mixpanel analytics](https://mixpanel.com/report/2288623/view/2835119/dashboards#id=879189)

- Flags
- disable sharding
- disable results upload
- fail fast
- disable usage statistics
- auto Google login

- Input
- Max tests shards
- apk path
- test apk path

## Prototype design

The mockup of the design is shown below:

![mock](flank_mock.png)

### Design elements

- At the top left side there are some small buttons to toggle state of boolean options
- Below there is text field to input `maxTestsShards`
- Below there are two text fields with buttons placed at the right to open file chooser/provide a path to files
- At the very bottom of left column there is a button to start Flank test run.
- On the right side there is a big window which is responsible for displaying output

## Setup

Please follow [getting started guide](https://github.com/JetBrains/compose-jb/tree/master/tutorials/Getting_Started) to set up new module for a prototype.
There is also a [gradle plugin](https://github.com/JetBrains/compose-jb/tree/master/gradle-plugins) for simplifying usage of Jetbrains compose.
More info on [project page](https://github.com/JetBrains/compose-jb/).

### Additional resources
- [IntelliJ Idea plugin](https://github.com/JetBrains/compose-jb/tree/master/examples/intelliJPlugin)
- [Tutorial](https://developer.android.com/jetpack/compose/layout)
- [Latest build](https://developer.android.com/jetpack/compose/layout)
- [Template to use without gradle](https://github.com/JetBrains/compose-jb/tree/master/templates)
Binary file added docs/desktop/flank_mock.png
Loading
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 6528ab5

Please sign in to comment.