https://github.com/neknaj/tsrust
Rust (とTypeScript) を使用して、ネイティブでもブラウザでも動く アプリケーションを構築するためのテンプレート
https://github.com/neknaj/tsrust
rust typescript wasm web
Last synced: about 2 months ago
JSON representation
Rust (とTypeScript) を使用して、ネイティブでもブラウザでも動く アプリケーションを構築するためのテンプレート
- Host: GitHub
- URL: https://github.com/neknaj/tsrust
- Owner: neknaj
- Created: 2024-12-27T00:52:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-01T06:29:18.000Z (about 1 year ago)
- Last Synced: 2025-04-01T07:23:15.245Z (about 1 year ago)
- Topics: rust, typescript, wasm, web
- Language: JavaScript
- Homepage: https://neknaj.github.io/tsrust/
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Rust (+TypeScript) アプリケーション テンプレート
このプロジェクトは、Rust (とTypeScript) を使用して、ネイティブでもブラウザでも動く アプリケーションを構築するためのテンプレートです。
### 想定しているアプリケーション
- 基本はネイティブで動くCLIアプリケーションで、それをWeb(ブラウザ)でも動かしたい
- 折角ブラウザを使うのだから、HTML/CSS/TS/JSを使って良い感じのGUIを付けたい
ネイティブ向けのGUIライブラリを使って、ネイティブでもGUIが使えるようにすることも可能な筈です
## 実行方法
### ブラウザ
```bash
npm install
node build.js
```
を実行後、ローカルサーバーを建てて
`/dist/index.html`をブラウザで開く
### ネイティブ
```bash
cargo run
```
を実行する
## 始め方
このテンプレートを使用するための手順は以下の通りです。
### 必要な環境
- Node.js (>=14.0.0)
- Rust (>=1.60.0)
- `wasm-pack` (Rust コードを WebAssembly にビルドするためのツール)
(Linuxの場合は、このリポジトリで$`npm run install-rust`を実行すればRustとwasm-packがインストールできます)
### 開発
1. このリポジトリをクローンします
### ネイティブ
2. buildします
$`cargo build`
$`cargo run`を実行すれば、ついでに実行してくれます
3. ファイルを編集します
`/src`内のファイルを編集して、アプリの機能を作成してください
編集したら`2`を再度行ってください
#### web
2. buildします
$`npm run build`を実行すれば、`/dist`に必要なファイルが作成されます
3. ローカルのサーバーで動かします
`/dist`をルートにしてサーバーを起動してください
$`npm run server`を実行すれば、http-serverを使ってローカルサーバーを起動できます
表示されるURLをWebブラウザで開いて下さい
4. ファイルを編集します
`/src`内のファイルを編集して、Webアプリの機能を作成してください
編集したら`2`~`3`を再度行ってください
5. Webアプリとして公開します
- Github Pages
`.github\workflows\deploy.yml`に、Github Actionsを使って公開するための設定があります
Githubにcommitすると、`gh-pages`ブランチが作られ、`/dist`の中身がその中に入ります
Githubリポジトリの`Settings > Pages`からGithub Pagesの設定を行ってください
- その他
GithubPagesと同様、`/dist`の中身をWebサーバーに配置すれば行えます