mirror of
https://github.com/DeviceFarmer/stf.git
synced 2026-04-23 06:15:16 +02:00
Cleaning README.
This commit is contained in:
26
CONTRIBUTING.md
Normal file
26
CONTRIBUTING.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# Contributing
|
||||||
|
|
||||||
|
We are happy to accept any contributions that make sense and respect the rules listed below.
|
||||||
|
|
||||||
|
## How to contribute
|
||||||
|
|
||||||
|
1. Fork the repo.
|
||||||
|
2. Create a feature branch for your contribution out of the `master` branch. Only one contribution per branch is accepted.
|
||||||
|
3. Implement your contribution while respecting our rules (see below).
|
||||||
|
4. If possible, add tests for your contribution to make sure it actually works.
|
||||||
|
5. Submit a pull request against our `master` branch!
|
||||||
|
|
||||||
|
## Rules
|
||||||
|
|
||||||
|
* **Do** use feature branches.
|
||||||
|
* **Do** conform to existing coding style so that your contribution fits in.
|
||||||
|
* **Do** use [EditorConfig] to enforce our [whitespace rules](.editorconfig). If your editor is not supported, enforce the settings manually.
|
||||||
|
* **Do not** touch the `version` field in [package.json](package.json).
|
||||||
|
* **Do not** commit any generated files, unless already in the repo. If absolutely necessary, explain why.
|
||||||
|
* **Do not** create any top level files or directories. If absolutely necessary, explain why and update [.npmignore](.npmignore).
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
By contributing your code, you agree to license your contribution under our [LICENSE](LICENSE).
|
||||||
|
|
||||||
|
[editorconfig]: <http://editorconfig.org/>
|
||||||
17
GETTING_STARTED.md
Normal file
17
GETTING_STARTED.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
Getting started
|
||||||
|
===
|
||||||
|
|
||||||
|
- `brew install rethinkdb`
|
||||||
|
- Make internal npm work
|
||||||
|
- `brew install protobuf`
|
||||||
|
- `brew install zmq`
|
||||||
|
- `npm install -g bower`
|
||||||
|
- `npm install`
|
||||||
|
- `bower install`
|
||||||
|
- `npm link`
|
||||||
|
|
||||||
|
Run
|
||||||
|
===
|
||||||
|
|
||||||
|
- `rethinkdb`
|
||||||
|
- `stf local`
|
||||||
17
LICENSE
Normal file
17
LICENSE
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
Copyright © CyberAgent, Inc. All Rights Reserved.
|
||||||
|
|
||||||
|
Licensed under the GNU AGPL, Version 3.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.gnu.org/licenses/agpl-3.0.html
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
|
||||||
|
If AGPL 3.0 is not suitable for your use case,
|
||||||
|
commercial licenses are also available from CyberAgent, Inc.,
|
||||||
|
including free licenses. Contact us at stf@cyberegant.co.jp
|
||||||
75
README.md
75
README.md
@@ -1,10 +1,10 @@
|
|||||||
# STF
|
# STF
|
||||||
===
|
===
|
||||||
STF (Smartphone Test Farm) is a service for remotely debugging real smartphone devices from the comfort of your browser.
|
STF (Smartphone Test Farm) is a full featured SaaS for remotely debugging real smartphone devices from the comfort of your browser.
|
||||||
|
|
||||||
Features
|
Features
|
||||||
===
|
===
|
||||||
- Support Android devices from 2.3 to 5.0
|
- Support Android devices from 2.3 to 5.0, including Android M
|
||||||
- Fast device screen transfer
|
- Fast device screen transfer
|
||||||
- Remote mouse and keyboard input
|
- Remote mouse and keyboard input
|
||||||
- Multitouch support
|
- Multitouch support
|
||||||
@@ -23,88 +23,37 @@ Features
|
|||||||
- Reverse port forwarding for development
|
- Reverse port forwarding for development
|
||||||
- Device hardware specific information
|
- Device hardware specific information
|
||||||
|
|
||||||
|
|
||||||
Getting started
|
|
||||||
===
|
|
||||||
|
|
||||||
- `brew install rethinkdb`
|
|
||||||
- Make internal npm work
|
|
||||||
- `brew install protobuf`
|
|
||||||
- `brew install zmq`
|
|
||||||
- `npm install -g bower`
|
|
||||||
- `npm install`
|
|
||||||
- `bower install`
|
|
||||||
- `npm link`
|
|
||||||
|
|
||||||
Requirements
|
Requirements
|
||||||
===
|
===
|
||||||
|
|
||||||
- NodeJS
|
- NodeJS
|
||||||
- Bower
|
- Bower
|
||||||
- RethinkDB
|
- RethinkDB
|
||||||
|
|
||||||
Run
|
Getting Started
|
||||||
===
|
===
|
||||||
|
|
||||||
- `rethinkdb`
|
See [GETTING_STARTED.md](GETTING_STARTED.md).
|
||||||
- `stf local`
|
|
||||||
|
|
||||||
Update
|
|
||||||
|
Updating
|
||||||
===
|
===
|
||||||
|
|
||||||
- `git pull`
|
See [UPDATING.md](UPDATING.md).
|
||||||
- `npm install`
|
|
||||||
- `bower install`
|
|
||||||
|
|
||||||
|
|
||||||
### Tests
|
Testing
|
||||||
|
===
|
||||||
## Unit Frontend
|
|
||||||
|
|
||||||
- `brew install phantomjs`
|
|
||||||
- `gulp karma`
|
|
||||||
|
|
||||||
## E2E Frontend
|
|
||||||
|
|
||||||
### On first run
|
|
||||||
- `gulp webdriver-update`
|
|
||||||
|
|
||||||
### Chrome Local STF
|
|
||||||
- Connect a device
|
|
||||||
- Run stf
|
|
||||||
- `gulp protractor`
|
|
||||||
|
|
||||||
### Multiple Browsers Local STF with a specific suite
|
|
||||||
- Connect a device
|
|
||||||
- Run stf
|
|
||||||
- `gulp protractor --multi --suite devices`
|
|
||||||
|
|
||||||
### Chrome Remote STF
|
|
||||||
- `export STF_URL='http://stf-url/#!/'`
|
|
||||||
- `export STF_USERNAME='user'`
|
|
||||||
- `export STF_PASSWORD='pass'`
|
|
||||||
- `gulp protractor`
|
|
||||||
|
|
||||||
|
|
||||||
|
See [TESTING.md](TESTING.md).
|
||||||
|
|
||||||
Contributing
|
Contributing
|
||||||
===
|
===
|
||||||
|
See [CONTRIBUTING.md](CONTRIBUTING.md).
|
||||||
|
|
||||||
|
|
||||||
License
|
License
|
||||||
===
|
===
|
||||||
|
See [LICENSE](LICENSE).
|
||||||
## Main repository
|
|
||||||
- Free Software Foundation’s [GNU AGPL v3.0](http://www.fsf.org/licensing/licenses/agpl-3.0.html).
|
|
||||||
- Commercial licenses are also available from [CyberAgent, Inc.](mailto:stf@cyberagent.co.jp), including free licenses.
|
|
||||||
|
|
||||||
## Small repositories
|
|
||||||
- [Apache License v2.0.](http://www.apache.org/licenses/LICENSE-2.0)
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
- Documentation: [Creative Commons](http://creativecommons.org/licenses/by-nc-sa/3.0/).
|
|
||||||
|
|
||||||
|
|
||||||
Copyright © CyberAgent, Inc. All Rights Reserved.
|
Copyright © CyberAgent, Inc. All Rights Reserved.
|
||||||
|
|
||||||
|
|||||||
25
TESTING.md
Normal file
25
TESTING.md
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
## Unit Frontend
|
||||||
|
|
||||||
|
- `brew install phantomjs`
|
||||||
|
- `gulp karma`
|
||||||
|
|
||||||
|
## E2E Frontend
|
||||||
|
|
||||||
|
### On first run
|
||||||
|
- `gulp webdriver-update`
|
||||||
|
|
||||||
|
### Chrome Local STF
|
||||||
|
- Connect a device
|
||||||
|
- Run stf
|
||||||
|
- `gulp protractor`
|
||||||
|
|
||||||
|
### Multiple Browsers Local STF with a specific suite
|
||||||
|
- Connect a device
|
||||||
|
- Run stf
|
||||||
|
- `gulp protractor --multi --suite devices`
|
||||||
|
|
||||||
|
### Chrome Remote STF
|
||||||
|
- `export STF_URL='http://stf-url/#!/'`
|
||||||
|
- `export STF_USERNAME='user'`
|
||||||
|
- `export STF_PASSWORD='pass'`
|
||||||
|
- `gulp protractor`
|
||||||
6
UPDATING.md
Normal file
6
UPDATING.md
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
Updating
|
||||||
|
===
|
||||||
|
|
||||||
|
- `git pull`
|
||||||
|
- `npm install`
|
||||||
|
- `bower install`
|
||||||
Reference in New Issue
Block a user