Skip to content

Commit

Permalink
Merge pull request #76 from omochi/doc-bt
Browse files Browse the repository at this point in the history
BrowserTestsのREADME
  • Loading branch information
omochi authored Apr 22, 2024
2 parents eadeb00 + 30706ec commit c4dd346
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 0 deletions.
60 changes: 60 additions & 0 deletions BrowserTests/README.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Browser Tests

このプロジェクトは Swift React をブラウザ上で実行させて手動でテストするためのものです。

実装されている React アプリケーションは [React 公式ドキュメント](https://ja.react.dev/learn) に出てくるコードを移植して作られています。

## パッケージ構造

複数の executable を生成するパッケージです。
それぞれが独立したウェブページで利用されます。
つまり、複数のアプリケーションをまとめてビルドしています。

JavaScriptライブラリについては、ローダとJavaScriptKitのランタイムライブラリをソースコードで配置していて、自前でビルドしています。ローダは [Carton の実装](https://github.com/swiftwasm/carton/tree/main/entrypoint)を元にしています。

## 環境構築

### Swift の準備

Wasm に対応した Swift が必要です。また、 Wasm SDK がインストールされている必要があります。[インストール方法はこちら](../docs/configure.ja.md)を参照してください。

### Node.js

Node.js が必要です。 Homebrew からインストールしてください。

```sh
$ brew install node
```

JSの依存ライブラリを以下のコマンドでインストールします。

```sh
$ npm install
```

## Swiftのビルド

ビルドコマンドはスクリプトにしています。

```sh
$ bin/build
```

## エントリポイントの生成

エントリポイントは `Package.swift` の中身に基づいて自動生成しています。
executable を追加した時は以下を実行して再生成する必要があります。

```sh
$ bin/gen-pages
```

## JSのビルドとホスト

以下のコマンドで、JavaScriptのビルドとコンテンツのホストが実行されます。

```sh
$ npm run dev
```

アクセスURLがそのままコンソールに表示されるので、ブラウザで開いてください。
7 changes: 7 additions & 0 deletions BrowserTests/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Browser Tests

This project is for running Swift React on a browser and manually testing it.

This document is in preparation.

[日本語はこちらです。](./README.ja.md)

0 comments on commit c4dd346

Please sign in to comment.