padloc - 個人およびチーム向けの最新のオープンソース パスワード マネージャー。

(A modern, open source password manager for individuals and teams.)

Created at: 2013-11-11 05:06:35
Language: JavaScript
License: AGPL-3.0

パドロック

個人およびチーム向けのシンプルで安全なパスワードおよびデータ管理。

このレポは複数のパッケージに分割されています。

パッケージ名 説明
@padloc/コア コアロジック
@padloc/アプリ Web ベースの UI コンポーネント
@padloc/サーバー バックエンド サーバー
@padloc/pwa プログレッシブ Web アプリである Web クライアント。
@padloc/ロケール 翻訳およびその他のローカリゼーション関連のものを含むパッケージ
@padloc/電子 Electron で構築されたデスクトップ アプリ
@padloc/コルドバ iOS および Android アプリを構築するための Cordova プロジェクト。
@padloc/タウリ Tauriを利用したクロスプラットフォームのネイティブ アプリ
@padloc/拡張子 Padloc ブラウザ拡張機能

使い方

概要セクションでわかるように、さまざまなコンポーネントで遊ぶことができます。ただし、最低限、Padloc の独自のインスタンスをセットアップして使用するには、 ServerWeb Clientをインストールして構成する必要があります。実際には、これを行うにはいくつかの方法がありますが、Padloc をローカルにインストールしてテストするだけであれば、非常に簡単です。

git clone git@github.com:padloc/padloc.git
cd padloc
npm ci
npm start

Web クライアントが で利用できるようになりました

http://localhost:8080

独自の「生産的な」バージョンの Padloc をホストする方法と、デスクトップおよびモバイル アプリの独自のバージョンを構築および配布する方法に関する詳細なガイドがまもなく公開されます。

貢献する

あらゆる種類の貢献を歓迎します!

バグの報告や機能のリクエストがある場合は、 Issueを作成してください 。

質問、フィードバックがある場合、または単にチャットしたい場合は、 ディスカッションセクションに進んでください。

新しい機能を実装したり、既存の問題を修正したりして Padloc に直接貢献したい場合は、お気軽に プル リクエストを作成してください。ただし、些細なことに取り組む予定がある場合は、まず、既存の問題にコメントするか、新しい問題を作成するか、ディスカッション セクションで ping を送信してください。

Padloc の作業を開始する方法について は、readmeの開発セクションを参照してください。

安全

セキュリティ設計の概要については、 セキュリティ ホワイトペーパーをご覧ください。

発達

設定

Padloc を使用するための開発環境のセットアップは、次のように簡単です。

git clone git@github.com:padloc/padloc.git
cd padloc
npm ci

これには 1 分ほどかかる場合があります。☕️.

開発モード

「開発モード」を開始するには、単に実行します

npm run dev

プロジェクトのルートから。これにより、バックエンド サーバー (デフォルトではポート でリッスン

3000
) と PWA ( で利用可能
http://localhost:8080
) がデフォルトで起動されます。

サーバーと PWA ポートは、それぞれ環境変数と環境変数で変更でき

PL_TRANSPORT_HTTP_PORT
ます
PL_PWA_PORT
。その他の構成オプションについては、サーバーpwaの構成セクションを 確認してください

書式設定

このプロジェクトはPrettierでフォーマットされています。.prettierrc.json仕様を使用してすべてのファイルを再フォーマットするには、プロジェクトのルートから次を実行します。

npm run format

すべてが正しくフォーマットされているかどうかを簡単に確認するには、次のコマンドを使用できます。

npm run format:check

テスト

単体テストを実行するには、次を使用します。

npm run test

サイプレスのエンド ツー エンド テストは、次の方法で実行できます。

npm run test:e2e

「開発モード」でサイプレス テストを開始するには:

npm run test:e2e:dev

依存関係の追加/削除

複数のパッケージからなるモノレポなので追加・削除 単一のパッケージへの/からの移動は、簡単ではない場合があります。以下 コマンドは、これを簡単にするためのものです。

パッケージに依存関係を追加するには、次を実行します。

scope=[package_name] npm run add [dependency]

そして、1つを削除するには:

scope=[package_name] npm run remove [dependency]

たとえば

typescript
@padloc/server
パッケージに追加する方法は次のとおりです。

scope=server npm run add typescript

:サードパーティの依存関係の数とサイズを維持しようとしています したがって、依存関係を追加する前に、それが本当にそうであるかどうかよく考えてください。 必要です!不要な依存関係を持つプル リクエストが発生する可能性が非常に高くなります。 拒否されました。

バージョンの更新

Padloc プロジェクトは、さまざまなサブパッケージで構成されています。簡素化する バージョン管理、それらすべてにグローバル バージョンを使用します。つまり、リリース時に 新しいバージョンに関係なく、すべてのサブパッケージのバージョンを更新する必要があります それらに変化があったかどうか。グローバルバージョンを更新するには プロジェクト全体で、次のコマンドを使用できます。

npm run version [semver_version]

導入・公開

Padlocには、すべてが必要なさまざまなコンポーネントがたくさんあります さまざまな方法で構築/リリース/公開されています。この複雑さを管理するために、 すべてのコンポーネントのすべての展開手順を単一の Github ワークフローにまとめました。に 新しいバージョンをリリースするには、次のようにします。

  1. プロジェクトのバージョンを更新する
  2. コミットしてプッシュします。
  3. リリースの公開 アクションを実行します 。

ライセンス

このソフトウェアは、 GNU Affero General Public Licenseの下で公開されています。取得をご希望の場合 商用ライセンス、お問い合わせください sales@padloc.app