-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
288 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
# Gopeed コントリビューターガイド | ||
|
||
まず最初に、Gopeed への貢献に興味を持っていただきありがとうございます。このガイドは、あなたが Gopeed の | ||
開発に参加するための手助けとなるでしょう。 | ||
|
||
## ブランチの説明 | ||
|
||
このプロジェクトのメインブランチは `main` ブランチのみです。Gopeed の開発に参加したい場合は、 | ||
まずこのプロジェクトをフォークし、フォークしたプロジェクトで開発を行ってください。開発が完了したら、 | ||
このプロジェクトに PR を提出し、`main` ブランチにマージしてください。 | ||
|
||
## ローカル開発 | ||
|
||
開発およびデバッグはウェブ上で行うことを推奨する。まずバックエンドのサービスを起動し、 | ||
コマンドライン `go run cmd/api/main.go` で起動する。サービスのデフォルトポートは `9999` で、 | ||
次にフロントエンドの flutter プロジェクトを `debug` モードで起動して実行します。 | ||
|
||
## 翻訳 | ||
|
||
Gopeed の国際化ファイルは `ui/flutter/assets/locales` ディレクトリにあります。 | ||
このディレクトリに対応する言語ファイルを追加するだけでよいです。 | ||
|
||
|
||
ロケール編集後にロケールを生成: | ||
|
||
|
||
``` | ||
get generate locales | ||
``` | ||
|
||
翻訳については `en_us.dart` を参照してください。 | ||
|
||
## flutter での開発 | ||
|
||
コミットする前に `dart format ./ui/flutter` を実行し、コードを標準の dart フォーマットにしておくことを忘れないでください | ||
|
||
api/models を編集したい場合は build_runner watcher をオンにします: | ||
|
||
``` | ||
flutter pub run build_runner watch | ||
``` | ||
|
||
|
||
get-cli コマンドの使用法: | ||
|
||
``` | ||
create: | ||
controller: Generate controller | ||
page: Use to generate pages | ||
view: Generate view | ||
generate: | ||
locales: Generate translation file from json files | ||
model: generate Class model from json | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,171 @@ | ||
[![Test Status](https://github.com/GopeedLab/gopeed/workflows/test/badge.svg)](https://github.com/GopeedLab/gopeed/actions?query=workflow%3Atest) | ||
[![Codecov](https://codecov.io/gh/GopeedLab/gopeed/branch/main/graph/badge.svg)](https://codecov.io/gh/GopeedLab/gopeed) | ||
[![Release](https://img.shields.io/github/release/GopeedLab/gopeed.svg)](https://github.com/GopeedLab/gopeed/releases) | ||
[![Download](https://img.shields.io/github/downloads/GopeedLab/gopeed/total.svg)](https://github.com/GopeedLab/gopeed/releases) | ||
[![Donate](https://img.shields.io/badge/%24-donate-ff69b4.svg)](https://github.com/GopeedLab/gopeed/blob/main/.donate/index.md#donate) | ||
[![Discord](https://img.shields.io/discord/1037992631881449472?label=Discord&logo=discord&style=social)](https://discord.gg/ZUJqJrwCGB) | ||
|
||
![](_docs/img/banner.png) | ||
|
||
[English](/README.md) | [中文](/README_zh-CN.md) | [日本語](/README_ja-JP.md) | ||
|
||
## はじめに | ||
|
||
Gopeed (正式名 Go Speed) は `Golang` + `Flutter` によって開発された高速ダウンローダーで、(HTTP、BitTorrent、Magnet) プロトコルをサポートし、すべてのプラットフォームをサポートします。 | ||
|
||
見て下さい ✈ [公式ウェブサイト](https://gopeed.com) | 📖 [開発ドキュメント](https://docs.gopeed.com) | ||
|
||
## インストール | ||
|
||
**サポートするプラットフォーム** | ||
|
||
- [x] windows | ||
- [x] macos | ||
- [x] linux | ||
- [x] android | ||
- [ ] ios | ||
- [x] web | ||
- [x] docker | ||
|
||
[ダウンロード](https://github.com/GopeedLab/gopeed/releases/latest) | ||
|
||
> ヒント: macos を開くのに失敗した場合は、ターミナルで `xattr -d com.apple.quarantine /Applications/Gopeed.app` コマンドを実行してください | ||
### コマンドツール | ||
|
||
`go install` を使用: | ||
|
||
```bash | ||
go install github.com/GopeedLab/gopeed/cmd/gopeed@latest | ||
``` | ||
|
||
### Docker | ||
|
||
#### 直接始める | ||
|
||
```bash | ||
docker run -d -p 9999:9999 -v /path/to/download:/download liwei2633/gopeed | ||
``` | ||
|
||
#### Docker Compose の使用 | ||
|
||
```bash | ||
docker-compose up -d | ||
``` | ||
|
||
#### Gopeed へのアクセス | ||
|
||
docker コンテナが起動しているときは、`http://localhost:9999` からウェブページにアクセスできます。 | ||
|
||
> ヒント: 設定ページでダウンロードパスを `/download` に変更すると、ホスト上でダウンロードしたファイルにアクセスできます。 | ||
## 寄付 | ||
|
||
もしこのプロジェクトがお気に召しましたら、このプロジェクトの発展を支援するために[寄付](/.donate/index.md#donate)をご検討ください! | ||
|
||
## ショーケース | ||
|
||
![](_docs/img/ui-demo.png) | ||
|
||
## 開発 | ||
|
||
このプロジェクトは二つの部分に分かれており、フロントエンドでは `flutter` を、バックエンドでは `Golang` を使用し、両者は `http` プロトコルで通信する。ユニックスシステムでは `unix socket` を、ウィンドウズシステムでは `tcp` プロトコルを使用します。 | ||
|
||
> フロントコードは `ui/flutter` ディレクトリにあります。 | ||
### 環境 | ||
|
||
1. Go 言語 1.19+ | ||
2. Flutter 3.7+ | ||
|
||
### クローン | ||
|
||
```bash | ||
git clone [email protected]:GopeedLab/gopeed.git | ||
``` | ||
|
||
### コントリビュート | ||
|
||
[CONTRIBUTING.md](/CONTRIBUTING_ja-JP.md) をご参照ください | ||
|
||
### ビルド | ||
|
||
#### デスクトップ | ||
|
||
まず、[flutter デスクトップ公式サイトドキュメント](https://docs.flutter.dev/development/platform-integration/desktop)に従って環境を設定し、自分で検索できる `cgo` 環境を用意します。 | ||
|
||
コマンド: | ||
|
||
- windows | ||
|
||
```bash | ||
go build -tags nosqlite -ldflags="-w -s" -buildmode=c-shared -o ui/flutter/windows/libgopeed.dll github.com/GopeedLab/gopeed/bind/desktop | ||
cd ui/flutter | ||
flutter build windows | ||
``` | ||
|
||
- macos | ||
|
||
```bash | ||
go build -tags nosqlite -ldflags="-w -s" -buildmode=c-shared -o ui/flutter/macos/Frameworks/libgopeed.dylib github.com/GopeedLab/gopeed/bind/desktop | ||
cd ui/flutter | ||
flutter build macos | ||
``` | ||
|
||
- linux | ||
|
||
```bash | ||
go build -tags nosqlite -ldflags="-w -s" -buildmode=c-shared -o ui/flutter/linux/bundle/lib/libgopeed.so github.com/GopeedLab/gopeed/bind/desktop | ||
cd ui/flutter | ||
flutter build linux | ||
``` | ||
|
||
#### モバイル | ||
|
||
先ほどと同じように、`cgo` 環境を準備し、`gomobile` をインストールする必要があります: | ||
|
||
```bash | ||
go install golang.org/x/mobile/cmd/gomobile@latest | ||
go get golang.org/x/mobile/bind | ||
gomobile init | ||
``` | ||
|
||
コマンド: | ||
|
||
- android | ||
|
||
```bash | ||
gomobile bind -tags nosqlite -ldflags="-w -s" -o ui/flutter/android/app/libs/libgopeed.aar -target=android -androidapi 19 -javapkg=com.gopeed github.com/GopeedLab/gopeed/bind/mobile | ||
cd ui/flutter | ||
flutter build apk | ||
``` | ||
|
||
#### Web | ||
|
||
コマンド: | ||
|
||
```bash | ||
cd ui/flutter | ||
flutter build web | ||
cd ../../ | ||
rm -rf cmd/web/dist | ||
cp -r ui/flutter/build/web cmd/web/dist | ||
go build -tags nosqlite,web -ldflags="-s -w" -o bin/ github.com/GopeedLab/gopeed/cmd/web | ||
go run cmd/web/main.go | ||
``` | ||
|
||
## 感謝 | ||
|
||
### コントリビューター | ||
|
||
<a href="https://github.com/GopeedLab/gopeed/graphs/contributors"> | ||
<img src="https://contrib.rocks/image?repo=GopeedLab/gopeed" /> | ||
</a> | ||
|
||
### JetBrains | ||
|
||
[![goland](_docs/img/goland.svg)](https://www.jetbrains.com/?from=gopeed) | ||
|
||
## ライセンス | ||
|
||
[GPLv3](LICENSE) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
{ | ||
"label": "日本語", | ||
"error": "エラー", | ||
"tip": "ヒント", | ||
"confirm": "確認", | ||
"cancel": "キャンセル", | ||
"selectAll": "すべてを選択", | ||
"task": "タスク", | ||
"downloading": "ダウンロード中", | ||
"downloaded": "ダウンロード済", | ||
"setting": "セッティング", | ||
"donate": "寄付する", | ||
"exit": "終了", | ||
"create": "タスクを作成", | ||
"downloadLink": "ダウンロードリンク", | ||
"downloadLinkValid": "ダウンロードリンクを入力してください", | ||
"downloadLinkHit": "ダウンロード リンクを入力してください、HTTP/HTTPS/MAGNET support@append", | ||
"downloadLinkHitDesktop": "または、torrent ファイルを直接ここにドラッグします", | ||
"download": "ダウンロード", | ||
"noFileSelected": "続行するには少なくとも 1 つのファイルを選択してください。", | ||
"noStoragePermission": "ストレージのパーミッションが必要", | ||
"selectFile": "ファイルを選択", | ||
"basic": "ベーシック", | ||
"advanced": "アドバンスド", | ||
"general": "ジェネラル", | ||
"downloadDir": "ディレクトリのダウンロード", | ||
"downloadDirValid": "ダウンロードディレクトリを選択してください", | ||
"connections": "接続", | ||
"maxRunning": "最大実行タスク", | ||
"items": "@count アイテム", | ||
"subscribeTracker": "トラッカーを購読", | ||
"subscribeFail": "登録に失敗しました。ネットワークを確認するか、後でもう一度お試しください", | ||
"update": "アップデート", | ||
"updateDaily": "毎日アップデート", | ||
"lastUpdate": "最終アップデート: @time", | ||
"addTracker": "トラッカーを追加", | ||
"addTrackerHit": "トラッカーサーバーの URL を 1 行に 1 つずつ入力してください", | ||
"ui": "UI", | ||
"theme": "テーマ", | ||
"themeSystem": "システム", | ||
"themeLight": "ライト", | ||
"themeDark": "ダーク", | ||
"locale": "言語", | ||
"about": "概要", | ||
"homepage": "ホームページ", | ||
"version": "バージョン", | ||
"protocol": "プロトコル", | ||
"port": "ポート", | ||
"apiToken": "API トークン", | ||
"notSet": "未設置", | ||
"set": "設置", | ||
"effectAfterRestart": "再起動後の効果", | ||
"startAll": "すべてを開始", | ||
"pauseAll": "すべてを一時停止", | ||
"deleteTask": "タスクを削除", | ||
"deleteTaskTip": "ダウンロードしたファイルを保持", | ||
"delete": "削除", | ||
"newVersionTitle": "新しいバージョン @version を発見する", | ||
"newVersionUpdate": "今すぐダウンロード", | ||
"newVersionLater": "後で" | ||
} |