https://github.com/smeghead/zo3ja

シンプルなRSSチェッカーです
https://github.com/smeghead/zo3ja

Last synced: 2 months ago
JSON representation

シンプルなRSSチェッカーです

Host: GitHub
URL: https://github.com/smeghead/zo3ja
Owner: smeghead
License: apache-2.0
Created: 2024-03-19T08:45:26.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-04-18T03:39:38.000Z (about 1 year ago)
Last Synced: 2025-02-07T22:53:43.978Z (4 months ago)
Language: Dockerfile
Homepage:
Size: 45.9 KB
Stars: 3
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

README

# zo3ja

シンプルなRSSチェッカーです。

## インストール

```bash
$ composer global require smeghead/zo3-ja
```

## 実行方法

global にインストールされた実行ファイルを実行します。(OSにより格納されるパスは異なります)

```bash
$ ~/.config/composer/vendor/bin/zo3ja
```

## カスタマイズ

* 設定ファイル $HOME/.config/zo3ja/zo3ja-config.phel

`-c`を指定して`zo3ja`を実行すると設定ファイルのパスを表示します。

```
$ ~/.config/composer/vendor/bin/zo3ja -c
```

### 設定項目

#### RSSフィードリスト `zo3ja\config\*feeds*`

チェックするフィードURLの一覧(`Vector`)です。この変数にフィードURLを追加することでチェックするフィードを追加できます。

#### キャッシュの有効期限 `zo3ja\config\*cache-seconds*`

取得したRSSフィードの情報を一定時間キャッシュします。キャッシュの時間を秒で指定することができます。
デフォルトは1時間です。

### 設定例

以下は、デフォルトのフィードに加えて、別のフィードを追加する例です。

```
(ns user-config
(:require zo3ja\config))

(set! config/*feeds* (push (deref config/*feeds*) "https://zenn.dev/smeghead/feed"))
```

## Development

### Open shell

```bash
docker compose build
docker compose run --rm php_cli bash
```

### Test

```bash
# vendor/bin/phel test
```