Part DB server

ドキュメント|デモ|ドッカーイメージ

パートDB

Part-DB は、電子部品用のオープンソース在庫管理システムです。 Web サーバーにインストールされるため、追加のソフトウェアをインストールすることなく、任意のブラウザでアクセスできます。

このリポジトリのバージョンは、最新のフレームワークに基づいて従来の Part-DB (バージョン < 1.0) を完全に書き直したもので、使用が推奨されるバージョンです。

バグを見つけた場合は、GitHub で問題をオープンしてください。そうすれば誰でも修正できるようになります。

デモ

Part-DB をインストールせずにテストしたい場合は、この Heroku インスタンスを使用できます。 (またはドイツ語版についてはこのリンク)。

ユーザー名: userおよびパスワード: userを使用してログインできます。

master ブランチへのすべての変更は自動的にデプロイされるため、現在の開発の進行状況を表しており、完全に安定していない可能性があります。無料の Heroku インスタンスが使用されているため、初めてページを読み込むときに時間がかかる場合があることに注意してください。

特徴

• 電子部品の在庫管理。各部品をカテゴリ、設置面積、メーカー、複数の店舗の場所と価格情報に割り当てることができます。パーツはタグを使用してグループ化できます。データシートや画像などのさまざまなファイルをパーツに関連付けることができます。
• 多言語サポート (現在、ドイツ語、英語、ロシア語、日本語、フランス語、チェコ語、デンマーク語、中国語)
• 部品および保管場所用のバーコード/ラベル生成器、内蔵バーコード スキャナーを使用して Web カメラ経由でバーコードをスキャン
• グループと詳細な (きめ細かな) 権限を持つユーザー システム。 2 要素認証 (Google Authenticator および Webauthn/U2F キー) がサポートされており、グループに対して強制できます。メールによるパスワードリセットを設定できます。
• SAML 経由のシングル サインオン (SSO) のオプション サポート (Keycloak などの中間サービスを使用して、Part-DB を既存の LDAP または Active Directory サーバーに接続できます)
• 部品とデータ構造のインポート/エクスポート システム。 KiCAD からのプロジェクトの BOM インポートがサポートされています。
• プロジェクト管理: プロジェクトを作成し、部品表 (BOM) に部品を割り当てます。これにより、どのくらいの頻度でこのプロジェクトを構築し、必要なすべてのコンポーネントを DB から直接引き出すことができるかを示します。
• イベントログ: インベントリにどのような変化が起こったか、どのユーザーが何をしたかを追跡します。パーツを古いバージョンに戻します。
• レスポンシブデザイン：PC、タブレット、スマートフォンで同じインターフェースでPart-DBを利用できます。
• MySQL、SQLite、PostgreSQL がデータベース バックエンドとしてサポートされています
• パーツ内のリッチテキストの説明とコメントのサポート
• 複数通貨のサポートと為替レートの自動更新をサポート
• パラメトリック検索（一部の仕様に従って部品を検索）を含む強力な検索およびフィルター機能
• 写真のサムネイルの自動生成
• クラウド プロバイダー (Octopart、Digikey、Farnell、LCSC、TME など) を使用して、部品情報、データシート、部品の価格を自動的に取得します
• 他のアプリケーション/スクリプトからPart-DBにアクセスするためのAPI
• KiCad との統合: Part-DB を KiCad の中央データソースとして使用し、KiCad 内で直接 Part-DB から利用可能なパーツを確認します。

これらの機能を備えた Part-DB は、個人の電子部品在庫を追跡したい愛好家や、多くのユーザーが共有在庫への (制御された) アクセスを必要とするメーカー スペースを追跡したい場合に役立ちます。

Part-DB は、中小企業や大学でも在庫管理に使用されています。

要件

• Symfony 6 を実行できるWeb サーバー(Apache2 や nginx など)。これには、 PHP 8.1の最小 PHP バージョンが含まれます。
• MySQL (少なくとも 5.7) / MariaDB (少なくとも 10.4) データベース サーバー、または SQLite を使用したくない場合はPostgreSQL 10 以降。
• サーバーへのシェル アクセスを強くお勧めします。
• クライアント側のアセットを構築するには、 yarnとnodejs (>= 18.0) が必要です。

インストール

Part-DB のレガシー (1.0.0 未満) バージョンをこのバージョンにアップグレードする場合は、最初にこれをお読みください。

ヒント: Docker イメージは jbtronics/part-db1 で入手できます。ここでは、docker 経由で Part-DB をセットアップする方法について説明します。

以下に、インストール プロセスの大まかな概要を示します。Part-DB のインストール方法に関する詳細なガイドについては、ここを参照してください。

1. このリポジトリをサーバー上のフォルダーにコピーまたはクローン作成します。
2. public/フォルダーからサービスを提供するように Web サーバーを構成します。追加情報については、ここを参照してください。
3. グローバル構成ファイルcp .env .env.localをコピーし、 .env.localを編集します。
   • 行APP_ENV=devをAPP_ENV=prodに変更します。
   • SQLite を使用したくない場合は、 DATABASE_URL=の値を必要に応じて形式に変更します (こちらを参照)。同時アクセスのある大規模なインスタンスでは、MySQL のパフォーマンスが向上します。これは後から簡単に変更できないため、慎重に選択してください。
4. Composer の依存関係をインストールし、自動ロード ファイルを生成します: composer install -o --no-dev
5. クライアント側の依存関係をインストールしてビルドします: yarn installとyarn build
6. オプション(最初のロードを高速化します): ウォームアップ キャッシュ: php bin/console cache:warmup
7. データベースを新しいスキームにアップグレードします (または空の場合は作成します): php bin/console doctrine:migrations:migrate 、指定された指示に従います。プロセス中に、管理者のパスワードが user として表示されます。コピーしてください。注意: これらの手順はデータベースを改ざんするため、データベースを破壊する可能性があります。したがって、データベースのバックアップを必ず作成してください。
8. Part-DB はconfig/parameters.yaml経由で構成できます。 Part-DB をインストール/アップグレードした後、設定が期待どおりかどうかを確認する必要があります。 partdb.default_currency主に使用する通貨と一致するかどうかを確認します (価格情報の作成後にこれを変更することはできません)。何かを変更するときは、 php bin/console cache:clearを実行します。
9. ブラウザで (指定した URL の下で) Part-DB にアクセスし、ユーザーadminでログインします。パスワードはDBセットアップ時に出力されたものです。パスワードを思い出せない場合は、 php bin/console app:set-password adminで新しいパスワードを設定します。 admin ユーザーで新しいユーザーを作成し、Part-DB の使用を開始できます。

新しいバージョンにアップグレードする場合は、新しいファイルをフォルダーにコピーし、手順 4. から 7. を繰り返します。

通常、データベースの初期作成時に管理者ユーザーが作成されると、ランダムなパスワードが生成されますが、 INITIAL_ADMIN_PW環境変数を設定することで、初期管理者パスワードを設定できます。

.env.localファイル内の環境変数を変更することで、ニーズに合わせて Part-DB を構成できます。詳細については、こちらを参照してください。

リバースプロキシ

リバース プロキシを使用している場合は、プロキシがX-Forwarded-*ヘッダーを正しく設定していることを確認する必要があります。そうしないと、HTTP/HTTPS が混同され、ホスト名が間違ってしまいます。リバース プロキシが別のサーバー上にある場合 (またはローカルホスト経由で Part-DB にアクセスできない場合)、リバース プロキシの IP アドレス (または IP ブロック) と一致するようにTRUSTED_PROXIES環境変数を設定する必要があります。これは、 .env.localまたは (docker を使用する場合) docker-compose.ymlファイルで行うことができます。

開発のために寄付する

Part-DB 開発者に寄付したい場合は、上部バー (リポジトリ名の横) にあるスポンサー ボタンを参照してください。そこでは、月次または 1 回限りで開発をサポートするさまざまな方法が見つかります。

で構築

• Symfony 5: サーバーサイド PHP に使用されるメインフレームワーク
• Bootstrap 5 と Bootswatch: Web サイトのテーマとして使用
• Fontwesome: アイコンセットとして使用
• ホットワイヤー スティミュラスとホットワイヤー ターボ: フロントエンド JavaScript

著者

• Jan Böhmer -初期作品- GitHub

このプロジェクトに参加した貢献者のリストもご覧ください。

Christoph Lechner と K. Jacobs によるオリジナルの Part-DB に基づく

ライセンス

Part-DB は、GNU Affero General Public License v3.0 (またはあなたの意見に応じてそれ以降) に基づいてライセンスされています。これは主に、AGPL に基づいて加えたすべての変更のソース コードを公開する限り、Part-DB を何にでも使用できる (商業的に使用することもできる) ことを意味します。

詳細については、「ライセンス」を参照してください。