https://github.com/shunsock/fortee_proposal_cli
Forteeに投稿されたプロポーザルデータをのURLを使ってダウンロード+表示するためのコマンドラインツールです．
https://github.com/shunsock/fortee_proposal_cli
cli command-line-tool rust
Last synced: over 1 year ago
JSON representation
Forteeに投稿されたプロポーザルデータをのURLを使ってダウンロード+表示するためのコマンドラインツールです．
- Host: GitHub
- URL: https://github.com/shunsock/fortee_proposal_cli
- Owner: shunsock
- License: mit
- Created: 2024-02-21T15:19:30.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T23:43:07.000Z (over 2 years ago)
- Last Synced: 2024-04-14T08:05:07.700Z (over 2 years ago)
- Topics: cli, command-line-tool, rust
- Language: Rust
- Homepage:
- Size: 12.2 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fortee Proposal CLI
## Overview
[Fortee](https://fortee.jp)に投稿されたプロポーザルデータをのURLを使ってダウンロード+表示するためのコマンドラインツールです．
URLを指定すると，プロポーザルデータをダウンロードします．以下のように動作します．
ダウンロードされるプロポーザルデータは以下のようなJSON形式です．
```json
{
"title": "Readable 正規表現",
"schedule": "2024/03/07 17:30〜",
"track": "Track A",
"speaker": "shunsock",
"proposal_page_url": "https://fortee.jp/phperkaigi-2024/proposal/eff9589b-b603-4b23-aa35-42948443a80b",
"og_image_url": "https://fortee.jp/phperkaigi-2024/proposal/og-image/eff9589b-b603-4b23-aa35-42948443a80b.png"
}
```
また，OGイメージもダウンロードされます．保存されたプロポーザルのJSONデータやOGイメージは以下の場所に保存されます．
```bash
$HOME/.fortee/html/proposal.json
$HOME/.fortee/image/og_image.{file_extension}
```
以下のようにコマンドラインで表示されるので，ここをコピー&ペーストすると楽に取得できます．
```bash
[notice] you can get data by running: cp /Users/shunsuke.tsuchiya/.fortee/json/proposal.json path/your/directory
[notice] you can get data by running: cp /Users/shunsuke.tsuchiya/.fortee/image/og_image.png path/your/directory
```
## Warning
このツールは，fortee公式にはサポートされていません．自己責任で使用してください．
また，これはテストバージョンです．正常に動作しない可能性があります．
## Requirements
以下のソフトウェアのインストールを前提としています．
- `Git`
- `Make`
以下のソフトウェアは開発者向けのものです．
- `Cargo`
## Getting Started
fortee community cliのインストールはマニュアルで行う必要があります．
```bash
git clone https://github.com/shunsock/fortee_proposal_cli.git
cd fortee_proposal_cli
make install
fortee -u https://fortee.jp/phperkaigi-2024/proposal/eff9589b-b603-4b23-aa35-42948443a80b
```
## Usage
### Download
```bash
git clone https://github.com/shunsock/fortee_proposal_cli.git
```
### Install & Uninstall
```bash
make install
make uninstall
```
### Help
```bash
fortee --help
```
### Download proposal data
```bash
fortee -u {your_proposal_url_page}
```
### (For Developer) Run All Rust Pre-Commit Checks
```bash
make watcher
```
### (For Developer) Install Rust Pre-Commit Components (rustfmt, clippy, etc.)
```bash
make install-dev
```
### (For Developer) Build Release Binary and Copy to `bin` Directory
```bash
make publish
```
## Contribution
このプロジェクトには，バグレポートや機能提案，コードの改善などのコントリビューションを歓迎します．
### Workflow
1. Fork the repository
2. Create Feature branch
3. Commit your changes
4. Push to the branch
5. Create a new Pull Request
### Install Development Tools
```bash
brew install rustup
make install-dev
```
### Confirm Rust Code
```bash
make watcher
```
### Check Binary Action
```bash
make publish
make install
fortee -u https://fortee.jp/phperkaigi-2024/proposal/eff9589b-b603-4b23-aa35-42948443a80b
```