Awesome
羽衣 - Hagoromo -
(English follows Japanese.)
概要
マルチカラム対応のBlueskyクライアントです。
動作確認環境
- Windows 11 Profesional
- Ubuntu 22.04
- Mac 10.15
使用ソフトウェア
- Qt 5.15.2
- OpenSSL 1.1.1q
- cpp-httplib
- zlib
- Qt HTTP Server(for unit test only)
ダウンロード
ビルド済みの実行ファイルはReleasesよりダウンロードしてください。
インストール
アーカイブを解凍して任意のフォルダに保存してください。
使用方法
ユーザーマニュアルを参照してください。
ビルド方法
共通
ビルドするプラットフォームのQt 5.15.2をインストールしてください。
Official site : Qt
Windows
Microsoft Visual Studio 2019をインストールしてください（Community Edition可）。
改行コードをCRLFでチェックアウトしてください。
REM checkout repo
>git clone git@github.com:ioriayane/Hagoromo.git
>cd Hagoromo
>git submodule update -i
REM copy and edit encryption seed
>copy lib\tools\encryption_seed_template.h lib\tools\encryption_seed.h
REM build Hagoromo
>.\scripts\build.bat path\to\Qt\5.15.2\msvc2019_64\bin
REM Execute
>deploy-hagoromo\hagoromo\Hagoromo.exe
Ubuntu
OpenSSL 1.1.1q 以上を使用します。build.shでビルドします。
# checkout repo
$ git clone git@github.com:ioriayane/Hagoromo.git
$ cd Hagoromo
$ git submodule update -i
# setup dependent modules
$ sudo apt-get install zlib1g-dev
# copy and edit encryption seed
$ cp lib/tools/encryption_seed_template.h lib/tools/encryption_seed.h
$ vi lib/tools/encryption_seed.h
# build Hagoromo
$ ./scripts/build.sh linux path/to/Qt/5.15.2/gcc_64/bin
# exec hagoromo
$ ./deploy-hagoromo/hagoromo/Hagoromo.sh
Mac
OpenSSL 1.1.1q 以上を使用します。build.shでビルドします。
# checkout repo
$ git clone git@github.com:ioriayane/Hagoromo.git
$ cd Hagoromo
$ git submodule update -i
# copy and edit encryption seed
$ cp lib/tools/encryption_seed_template.h lib/tools/encryption_seed.h
$ vi lib/tools/encryption_seed.h
# build Hagoromo
$ ./scripts/build.sh mac path/to/Qt/5.15.2/gcc_64/bin
# exec hagoromo
$ open ./deploy-hagoromo/hagoromo/Hagoromo.app
Qt Creatorでのビルドについて
単体テストで使用しているQt HTTP Serverのビルドとインストールが必要です。
Qt HTTP Serverのビルド方法
$ git submodule update -i --recursive 3rdparty/qthttpserver/
$ mkdir 3rdparty/build-qthttpserver
$ cd 3rdparty/build-qthttpserver
$ qmake CONFIG+=debug_and_release ../qthttpserver/qthttpserver.pro
$ make && make install
コントリビューション
変更を加えるときはdevからブランチして、devにプルリクエストを提出してください。
また、下記の事項を実施してください。Github Actionsにてチェックしています。
ソースコードの整形
pre-commitを使用しています。
git hookで実行されるように公式サイトを確認してセットアップしてください。
セットアップ例
$ pip install pre-commit
$ pre-commit --version
pre-commit 3.7.1
$ cd path/to/this_repo
$ pre-commit install
pre-commit installed at .git/hooks/pre-commit
単体テスト
いづれかの環境で実行してクリアできることを確認してください。
Windows
> .\scripts\unittest.bat path\to\Qt\5.15.2\msvc2019_64\bin
Ubuntu
$ ./scripts/unittest.sh linux path/to/Qt/5.15.2/gcc_64/bin
Mac
$ ./scripts/unittest.sh mac path/to/Qt/5.15.2/gcc_64/bin
Overview
This is a multi-column Bluesky client.
System Requirements
- Windows 11 Profesional
- Ubuntu 22.04
- Mac 10.15
Software used
- Qt 5.15.2
- OpenSSL 1.1.1q
- cpp-httplib
- zlib
- Qt HTTP Server(for unit test only)
Download
Please download the pre-built executable from Releases.
Installation
Unzip the archive and save it in any folder.
How to Use
Please refer to the User's Manual.
How to Build
Common
Install Qt 5.15.2 for the platform you want to build.
Official site : Qt
Windows
Install Microsoft Visual Studio 2019 (Community Edition is also available).
Check out the newline code in CRLF.
REM checkout repo
>git clone git@github.com:ioriayane/Hagoromo.git
>cd Hangoromo
>git submodule update -i
REM copy and edit encryption seed
>copy lib\tools\encryption_seed_template.h lib\tools\encryption_seed.h
REM build Hagoromo
>.\scripts\build.bat path\to\Qt\5.15.2\msvc2019_64\bin
REM Execute
>deploy-hagoromo\hagoromo\Hagoromo.exe
Ubuntu
OpenSSL 1.1.1q or higher is required. It is built in build.sh.
# checkout repo
$ git clone git@github.com:ioriayane/Hagoromo.git
$ cd Hagoromo
$ git submodule update -i
# setup dependent modules
$ sudo apt-get install zlib1g-dev
# copy and edit encryption seed
$ cp lib/tools/encryption_seed_template.h lib/tools/encryption_seed.h
$ vi lib/tools/encryption_seed.h
# build Hagoromo
$ ./scripts/build.sh linux path/to/Qt/5.15.2/gcc_64/bin
# exec hagoromo
$ ./deploy-hagoromo/hagoromo/Hagoromo.sh
Mac
OpenSSL 1.1.1q or higher is required. It is built in build.sh.
# checkout repo
$ git clone git@github.com:ioriayane/Hagoromo.git
$ cd Hagoromo
$ git submodule update -i
# copy and edit encryption seed
$ cp lib/tools/encryption_seed_template.h lib/tools/encryption_seed.h
$ vi lib/tools/encryption_seed.h
# build Hagoromo
$ ./scripts/build.sh mac path/to/Qt/5.15.2/gcc_64/bin
# exec hagoromo
$ open ./deploy-hagoromo/hagoromo/Hagoromo.app
About building with Qt Creator
You need to build and install Qt HTTP Server, which is used for unit testing.
How to build Qt HTTP Server
$ git submodule update -i --recursive 3rdparty/qthttpserver/
$ mkdir 3rdparty/build-qthttpserver
$ cd 3rdparty/build-qthttpserver
$ qmake CONFIG+=debug_and_release ../qthttpserver/qthttpserver.pro
$ make && make install
Contribution
If you want to make changes, please branch from dev and submit a pull request to dev.
Also, please do the following: Check in Github Actions.
Code formatting
pre-commit are used for source code formatting. Please check the official site and set it up to run with git hook.
Setup Example
$ pip install pre-commit
$ pre-commit --version
pre-commit 3.7.1
$ cd path/to/this_repo
$ pre-commit install
pre-commit installed at .git/hooks/pre-commit
Unit Tests
Please confirm that you can clear it by running it in one of the environments.
Windows
> .\scripts\unittest.bat path\to\Qt\5.15.2\msvc2019_64\bin
Ubuntu
$ ./scripts/unittest.sh linux path/to/Qt/5.15.2/gcc_64/bin
Mac
$ ./scripts/unittest.sh mac path/to/Qt/5.15.2/gcc_64/bin