Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #10

Merged
merged 1 commit into from
Apr 1, 2018
Merged

Update README.md #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Update README.md
  • Loading branch information
@oneut
oneut committed Apr 1, 2018
commit 4f8ca93454f630ebea4363e9ba77ae685ac1cd26
46 changes: 22 additions & 24 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 10,9 @@ LRPはgolang製のLive Reload Proxyです。

# モチベーション
Live Reloadを簡単にしたい
汎用的に使える
特定の言語に依存しない
特定の言語に依存せず、汎用的に使える
複数のプログラミング言語を考慮できる
コンパイルが必要な言語は自動的に再コンパイルしたい
設定を簡単にしたい
コンパイルが必要な言語は自動的に再コンパイルできる
golangで何かを作ってみたかった
初golangアプリケーション
各Live Reloadツールのメリット・デメリットを検討した結果、機能をいいとこ取りすると便利になりそうだった
Expand All @@ -33,24 31,21 @@ LRPはgolang製のLive Reload Proxyです。
コマンドの起動を制御できる
プロキシサーバは含まれていなかったので、エクステンション等が必要

# 特徴
# 主な特徴
プロキシサーバを経由してLive Reloadを行う
ブラウザに対してエクステンションを必要としない
htmlに特定のスクリプトを差し込む必要がない
設定をyamlで定義できる
ファイル監視ができる
変更を検知してLive Reloadイベントの発火が可能
ファイル作成
ファイル更新
ファイル削除
ディレクトリ作成
ディレクトリ削除
除外設定
コマンドを管理できる
restartを管理できる
標準出力のキーワードでLive Reloadイベントの発火が可能
静的サーバとしての起動
プロキシサーバとして使用した際にはスタブ機能として動作
Live Reload用のスクリプトファイルはプロキシサーバが自動的に付与する
ブラウザのエクステンションを必要としない
htmlに特定のスクリプトを差し込む必要がない
設定をyamlで定義
ファイル監視
ファイル変更、ディレクトリ変更を検知してLive Reloadイベントを発火
除外設定も可能
コマンド管理
Live Reloadイベント発火時にコマンドのrestartが可能
標準出力のキーワードでLive Reloadイベントを発火
静的Webサーバ
任意のディレクトリを静的Webサーバとして公開可能
任意のディレクトリのファイルを優先させるスタブ機能として使用可能
ポーリング機能は今のところない
ローカルで動かすことを目的としているので優先度が低い
必要そうなら実装を検討する
Expand Down Expand Up @@ -104,6 99,10 @@ tasks:
- node_modules
```

# 設定例
[Local Web Server](https://github.com/oneut/lrp/tree/master/examples/local-web-server)
[Local Web Server with webpack](https://github.com/oneut/lrp/tree/master/examples/local-web-server-with-webpack)

# オプション
## proxy
Live Reloadのプロキシサーバを管理します。
Expand Down Expand Up @@ -174,6 173,8 @@ source:
host: "localhost:8080"
```

`source.host`を設定した場合、ブラウザにアクセスした時には`proxy.host`の値に自動的に置換されます。

## source.replaces
プロキシを経由してアクセスしているサイトのHTMLデータを条件を指定して置換します。
複数の設定が可能です。
Expand Down Expand Up @@ -336,9 337,6 @@ tasks:
- ./node_modules
```

# 設定例
あとで書く

# todo
test
リファクタリング
Expand Down
2 changes: 2 additions & 0 deletions examples/local-web-server-with-webpack/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 2,8 @@

This is a example that monitors the standard output of webpack and performs Live Reload to the local web server.

![local web server with webpack example](https://raw.githubusercontent.com/oneut/lrp/master/examples/local-web-server-with-webpack/local-web-server-with-webpack.gif)

## Doing
Live Reload
Source website is local web server.
Expand Down
2 changes: 2 additions & 0 deletions examples/local-web-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 2,8 @@

This is a example that monitors files and performs Live Reload to the local web server.

![local web server example](https://raw.githubusercontent.com/oneut/lrp/master/examples/local-web-server/local-web-server.gif)

## Doing
Live Reload
Source website is local web server.
Expand Down