LatteArt

日本語版 Readme はこちらを参照して下さい。

Project Setup

1. Install node.js v14.15.3.
2. Install yarn corresponding to the version of node.js.
3. Go to the root directory of the project.
4. Execute the following command.

   yarn install

Build

Build LatteArt

1. Go to the root directory of the project.
2. Execute the following command.

   yarn package

3. The following directory is created in dist/latteart.

   dist/latteart/
       ├─ capture.bat # batch file
       ├─ manage.bat  # batch file
       ├─ launch.config.json # batch execution configuration file
       ├─ launch.exe # executable file for Windows
       ├─ latteart/
       │        ├─ public/ # contains index.html and favicon
       │        └─ latteart.exe # executable file for Windows
       └─ latteart-repository/
                ├─ history-viewer/ # snapshot viewer (review view)
                └─ snapshot-viewer/ # snapshot viewer

Watch (for developer)

Detect source code changes and rebuild LatteArt.

GUI

1. Go to the root directory of the project.
2. Execute the following command to start development server. (If you update a source code, that is rebuilt automatically.)

   yarn serve

Server

1. Go to the root directory of the project.
2. Execute the following command.

   yarn watch:server

3. The directory dist is created in the current directory, and dist contains built index.js. (If you update a source code, it is rebuilt automatically.)
4. Execute the following command.

   yarn start:server

Install

1. Put generated latteart directory into any directory.
2. Put latteart-capture-cl and latteart-repository directories into latteart directory.

   latteart/
       ├─ capture.bat
       ├─ manage.bat
       ├─ launch.config.json
       ├─ launch.exe
       ├─ latteart/
       ├─ latteart-capture-cl/ # put
       └─ latteart-repository/ # merge

Run

1. Execute the following script.
   • Capture tool
     • capture.bat
   • Test management tool
     • manage.bat
2. The tools are executed on a new tab in a web browser. (You can also execute the tools by opening the following URLs.)
   • Capture tool
     • http://127.0.0.1:3000
   • Test management tool
     • http://127.0.0.1:3000?mode=manage

Close

1. Close the window with the following message displayed.

   capture: http://127.0.0.1:3000
   manage: http://127.0.0.1:3000?mode=manage

2. The other windows are automatically closed.

How to Use the Capture Tool

on Windows or Mac

1. Select "Windows" from the "platform" list on the config page.
2. Enter the URL of an application that you want to test and press the "Start" button.

on Android

1. Select "Android" from the "platform" list on the config page.
2. Select the connected device name in the "Device advanced settings" on the config page.
3. If you want to test the application on the local server via remote device features of Chrome Devtools, set the wait time until reloading a browser because it takes a little time to recognize the device.
4. Enter the URL of an application that you want to test and press the "Start" button.

Contributing to LatteArt

Please read this document to contribute to LatteArt.

Contact

If you have any questions about LatteArt, please post them to Discussions on GitHub.

For other inquiries, please contact NTT Software Innovation Center (iso-tool-support-p-ml [at] hco.ntt.co.jp).

License

This software is licensed under the Apache License, Version2.0.