Part DB server

Dokumentation | Demo | Docker-Image

Teil-DB

Part-DB ist ein Open-Source-Bestandsverwaltungssystem für Ihre elektronischen Komponenten. Es wird auf einem Webserver installiert und kann daher mit jedem Browser aufgerufen werden, ohne dass zusätzliche Software installiert werden muss.

Die Version in diesem Repository ist eine vollständige Neufassung der alten Part-DB (Version < 1.0) basierend auf einem modernen Framework und ist die empfohlene Version.

Wenn Sie einen Fehler finden, öffnen Sie bitte ein Problem auf GitHub, damit es für alle behoben werden kann.

Demo

Wenn Sie Part-DB testen möchten, ohne es zu installieren, können Sie diese Heroku-Instanz verwenden. (Oder dieser Link für die deutsche Version).

Sie können sich mit dem Benutzernamen: user und dem Passwort: user anmelden.

Jede Änderung am Master-Zweig wird automatisch bereitgestellt, sodass sie den aktuellen Entwicklungsfortschritt darstellt und möglicherweise nicht vollständig stabil ist. Bitte beachten Sie, dass die kostenlose Heroku-Instanz verwendet wird, sodass es beim ersten Laden der Seite einige Zeit dauern kann.

Merkmale

• Bestandsverwaltung Ihrer elektronischen Teile. Jedes Teil kann einer Kategorie, einer Stellfläche, einem Hersteller sowie mehreren Filialstandorten und Preisinformationen zugeordnet werden. Teile können mithilfe von Tags gruppiert werden. Sie können den Teilen verschiedene Dateien wie Datenblätter oder Bilder zuordnen.
• Mehrsprachige Unterstützung (derzeit Deutsch, Englisch, Russisch, Japanisch, Französisch, Tschechisch, Dänisch und Chinesisch)
• Barcode-/Etikettengenerator für Teile und Lagerorte, Scannen von Barcodes per Webcam mit dem integrierten Barcode-Scanner
• Benutzersystem mit Gruppen und detaillierten (feingranularen) Berechtigungen. Die Zwei-Faktor-Authentifizierung wird unterstützt (Google Authenticator und Webauthn/U2F-Schlüssel) und kann für Gruppen erzwungen werden. Es kann ein Passwort-Reset per E-Mail eingerichtet werden.
• Optionale Unterstützung für Single Sign-On (SSO) über SAML (mithilfe eines Zwischendienstes wie Keycloak können Sie Part-DB mit einem vorhandenen LDAP- oder Active Directory-Server verbinden)
• Import-/Exportsystem für Teile und Datenstruktur. Der Stücklistenimport für Projekte aus KiCAD wird unterstützt.
• Projektmanagement: Erstellen Sie Projekte und weisen Sie der Stückliste Teile zu, um zu zeigen, wie oft Sie dieses Projekt erstellen und alle benötigten Komponenten direkt aus der Datenbank entnehmen können
• Ereignisprotokoll: Verfolgen Sie, welche Änderungen an Ihrem Inventar vorgenommen werden, und verfolgen Sie, welcher Benutzer was tut. Stellen Sie Ihre Teile auf ältere Versionen zurück.
• Responsive Design: Sie können Part-DB auf Ihrem PC, Ihrem Tablet und Ihrem Smartphone über dieselbe Oberfläche nutzen.
• Als Datenbank-Backends werden MySQL, SQLite und PostgreSQL unterstützt
• Unterstützung für Rich-Text-Beschreibungen und Kommentare in Teilen
• Unterstützung für mehrere Währungen und automatische Aktualisierung der Wechselkurse
• Leistungsstarke Such- und Filterfunktion, einschließlich parametrischer Suche (Suche nach Teilen gemäß bestimmten Spezifikationen)
• Automatische Miniaturbildgenerierung für Bilder
• Nutzen Sie Cloud-Anbieter (wie Octopart, Digikey, Farnell, LCSC oder TME), um automatisch Teileinformationen, Datenblätter und Preise für Teile zu erhalten
• API für den Zugriff auf Part-DB von anderen Anwendungen/Skripten aus
• Integration mit KiCad: Nutzen Sie Part-DB als zentrale Datenquelle für Ihr KiCad und sehen Sie verfügbare Teile von Part-DB direkt in KiCad.

Mit diesen Funktionen ist Part-DB nützlich für Bastler, die den Überblick über ihren privaten Bestand an elektronischen Teilen behalten möchten, oder für Makerspaces, in denen viele Benutzer (kontrollierten) Zugriff auf den gemeinsamen Bestand haben sollten.

Part-DB wird auch von kleinen Unternehmen und Universitäten zur Verwaltung ihrer Bestände genutzt.

Anforderungen

• Ein Webserver (wie Apache2 oder Nginx), der Symfony 6 ausführen kann, dazu gehört eine PHP-Mindestversion von PHP 8.1
• Ein MySQL- Datenbankserver (mindestens 5.7) / MariaDB (mindestens 10.4) oder PostgreSQL 10+, wenn Sie SQLite nicht verwenden möchten.
• Der Shell-Zugriff auf Ihren Server wird dringend empfohlen!
• Zum Erstellen der clientseitigen Assets werden Yarn und NodeJS (>= 18.0) benötigt.

Installation

Wenn Sie Ihre ältere Version (< 1.0.0) von Part-DB auf diese Version aktualisieren möchten, lesen Sie dies bitte zuerst.

Hinweis: Ein Docker-Image ist unter jbtronics/part-db1 verfügbar. Wie Sie Part-DB über Docker einrichten, wird hier beschrieben.

Nachfolgend finden Sie einen sehr groben Überblick über den Installationsprozess. Eine detaillierte Anleitung zur Installation von Part-DB finden Sie hier.

1. Kopieren oder klonen Sie dieses Repository in einen Ordner auf Ihrem Server.
2. Konfigurieren Sie Ihren Webserver so, dass er aus dem Ordner public/ “ bereitgestellt wird. Weitere Informationen finden Sie hier.
3. Kopieren Sie die globale Konfigurationsdatei cp .env .env.local und bearbeiten Sie .env.local :
   • Ändern Sie die Zeile APP_ENV=dev in APP_ENV=prod
   • Wenn Sie SQLite nicht verwenden möchten, ändern Sie den Wert von DATABASE_URL= entsprechend Ihren Anforderungen (siehe hier) für das Format. In größeren Instanzen mit gleichzeitigen Zugriffen ist MySQL leistungsfähiger. Dies kann später nicht einfach geändert werden, wählen Sie also mit Bedacht aus.
4. Installieren Sie Composer-Abhängigkeiten und generieren Sie Autoload-Dateien: composer install -o --no-dev
5. Installieren Sie clientseitige Abhängigkeiten und erstellen Sie sie: yarn install und yarn build
6. Optional (beschleunigt den ersten Ladevorgang): Warmup-Cache: php bin/console cache:warmup
7. Aktualisieren Sie die Datenbank auf ein neues Schema (oder erstellen Sie sie, wenn sie leer war): php bin/console doctrine:migrations:migrate und befolgen Sie die gegebenen Anweisungen. Während des Vorgangs wird das Passwort des Admin-Benutzers angezeigt. Kopieren Sie es. Achtung : Diese Schritte manipulieren Ihre Datenbank und könnten sie möglicherweise zerstören. Stellen Sie daher sicher, dass Sie ein Backup Ihrer Datenbank erstellen.
8. Sie können Part-DB über config/parameters.yaml konfigurieren. Sie sollten überprüfen, ob die Einstellungen Ihren Erwartungen entsprechen, nachdem Sie Part-DB installiert/aktualisiert haben. Überprüfen Sie, ob partdb.default_currency mit Ihrer hauptsächlich verwendeten Währung übereinstimmt (dies kann nach dem Erstellen der Preisinformationen nicht mehr geändert werden). Führen Sie php bin/console cache:clear wenn Sie etwas ändern.
9. Greifen Sie in Ihrem Browser auf Part-DB zu (unter der von Ihnen eingegebenen URL) und melden Sie sich mit dem Benutzer admin an. Das Passwort wird während der DB-Einrichtung ausgegeben. Wenn Sie sich nicht an das Passwort erinnern können, legen Sie mit php bin/console app:set-password admin ein neues fest. Mit dem Admin-Benutzer können Sie neue Benutzer erstellen und mit der Nutzung von Part-DB beginnen.

Wenn Sie auf eine neuere Version aktualisieren möchten, kopieren Sie einfach die neuen Dateien in den Ordner und wiederholen Sie die Schritte 4. bis 7.

Normalerweise wird ein zufälliges Passwort generiert, wenn der Admin-Benutzer während der ersten Datenbankerstellung erstellt wird. Sie können jedoch das anfängliche Admin-Passwort festlegen, indem Sie die Umgebungsvariable INITIAL_ADMIN_PW festlegen.

Sie können Part-DB entsprechend Ihren Anforderungen konfigurieren, indem Sie Umgebungsvariablen in der Datei .env.local ändern. Weitere Informationen finden Sie hier.

Reverse-Proxy

Wenn Sie einen Reverse-Proxy verwenden, müssen Sie sicherstellen, dass die Proxys die X-Forwarded-* Header richtig setzen, sonst kommt es zu einer HTTP/HTTPS-Verwechslung und falschen Hostnamen. Wenn sich der Reverse-Proxy auf einem anderen Server befindet (oder nicht über localhost auf Part-DB zugreifen kann), müssen Sie die Umgebungsvariable TRUSTED_PROXIES so einstellen, dass sie mit der IP-Adresse (oder dem IP-Block) Ihres Reverse-Proxys übereinstimmt. Sie können dies in Ihrer .env.local oder (bei Verwendung von Docker) in Ihrer docker-compose.yml Datei tun.

Spenden Sie für die Entwicklung

Wenn Sie an den Part-DB-Entwickler spenden möchten, sehen Sie sich die Sponsorenschaltfläche in der oberen Leiste (neben dem Repo-Namen) an. Dort finden Sie verschiedene Möglichkeiten, die Entwicklung monatlich oder einmalig zu unterstützen.

Gebaut mit

• Symfony 5: Das Hauptframework für serverseitiges PHP
• Bootstrap 5 und Bootswatch: Wird als Website-Theme verwendet
• Fontawesome: Wird als Icon-Set verwendet
• Hotwire Stimulus und Hotwire Turbo: Frontend-Javascript

Autoren

• Jan Böhmer – Erste Arbeit – GitHub

Siehe auch die Liste der Mitwirkenden, die an diesem Projekt teilgenommen haben.

Basierend auf der Original-Part-DB von Christoph Lechner und K. Jacobs

Lizenz

Part-DB ist unter der GNU Affero General Public License v3.0 (oder Ihrer Meinung nach auch später) lizenziert. Dies bedeutet hauptsächlich, dass Sie Part-DB für alles verwenden können, was Sie möchten (sogar kommerziell nutzen), solange Sie den Quellcode für jede Änderung, die Sie unter der AGPL vornehmen, ebenfalls veröffentlichen.

Weitere Informationen finden Sie unter LIZENZ.