Part DB server

Documentação | Demonstração | Imagem Docker

Parte-DB

Part-DB é um sistema de gerenciamento de inventário de código aberto para seus componentes eletrônicos. Ele é instalado em um servidor web e portanto pode ser acessado com qualquer navegador sem a necessidade de instalação de software adicional.

A versão neste repositório é uma reescrita completa do Part-DB legado (versão <1.0) baseado em uma estrutura moderna e é a versão recomendada para uso.

Se você encontrar um bug, abra um problema no GitHub, para que possa ser corrigido para todos.

Demonstração

Se quiser testar o Part-DB sem instalá-lo, você pode usar esta instância do Heroku. (Ou este link para a versão alemã).

Você pode fazer login com nome de usuário: usuário e senha: usuário .

Cada alteração no branch master é implantada automaticamente, portanto representa o progresso atual do desenvolvimento e pode não ser completamente estável. Lembre-se de que a instância gratuita do Heroku é usada, por isso pode levar algum tempo ao carregar a página pela primeira vez.

Características

• Gerenciamento de estoque de suas peças eletrônicas. Cada peça pode ser atribuída a uma categoria, área ocupada, fabricante e vários locais de armazenamento e informações de preço. As peças podem ser agrupadas usando tags. Você pode associar vários arquivos, como folhas de dados ou imagens, às peças.
• Suporte multilíngue (atualmente alemão, inglês, russo, japonês, francês, tcheco, dinamarquês e chinês)
• Gerador de códigos de barras/etiquetas para peças e locais de armazenamento, digitalize códigos de barras via webcam usando o leitor de código de barras integrado
• Sistema de usuários com grupos e permissões detalhadas (granulares finas). A autenticação de dois fatores é suportada (chaves Google Authenticator e Webauthn/U2F) e pode ser aplicada a grupos. A redefinição de senha por e-mail pode ser configurada.
• Suporte opcional para logon único (SSO) via SAML (usando um serviço intermediário como Keycloak, você pode conectar o Part-DB a um servidor LDAP ou Active Directory existente)
• Sistema de importação/exportação de peças e estrutura de dados. A importação de BOM para projetos do KiCAD é suportada.
• Gerenciamento de projetos: Crie projetos e atribua peças à lista de materiais (BOM), para mostrar com que frequência você poderia construir este projeto e retirar diretamente todos os componentes necessários do banco de dados
• Log de eventos: rastreie quais mudanças acontecem em seu inventário, rastreie qual usuário faz o quê. Reverta suas peças para versões mais antigas.
• Design responsivo: você pode usar o Part-DB em seu PC, tablet e smartphone usando a mesma interface.
• MySQL, SQLite e PostgreSQL são suportados como backends de banco de dados
• Suporte para descrições de rich text e comentários em partes
• Suporte para múltiplas moedas e atualização automática de taxas de câmbio suportadas
• Poderosa função de pesquisa e filtro, incluindo pesquisa paramétrica (pesquisa de peças de acordo com algumas especificações)
• Geração automática de miniaturas para fotos
• Use provedores de nuvem (como Octopart, Digikey, Farnell, LCSC ou TME) para obter automaticamente informações, planilhas de dados e preços de peças
• API para acessar Part-DB de outros aplicativos/scripts
• Integração com KiCad: Use Part-DB como fonte de dados central para seu KiCad e veja as peças disponíveis do Part-DB diretamente dentro do KiCad.

Com esses recursos, o Part-DB é útil para amadores que desejam acompanhar seu inventário privado de peças eletrônicas ou espaços de fabricante, onde muitos usuários devem ter acesso (controlado) ao inventário compartilhado.

O Part-DB também é usado por pequenas empresas e universidades para gerenciar seus estoques.

Requisitos

• Um servidor web (como Apache2 ou nginx) que seja capaz de rodar Symfony 6, incluindo uma versão PHP mínima do PHP 8.1
• Um servidor de banco de dados MySQL (pelo menos 5.7) / MariaDB (pelo menos 10.4) ou PostgreSQL 10+ se você não quiser usar SQLite.
• O acesso Shell ao seu servidor é altamente recomendado!
• Para construir os ativos do lado do cliente, são necessários fios e nodejs (>= 18.0).

Instalação

Se você deseja atualizar sua versão herdada (<1.0.0) do Part-DB para esta versão, leia isto primeiro.

Dica: uma imagem docker está disponível em jbtronics/part-db1. Como configurar o Part-DB via docker é descrito aqui.

Abaixo você encontra um esboço muito aproximado do processo de instalação, veja aqui um guia detalhado sobre como instalar o Part-DB.

1. Copie ou clone este repositório em uma pasta no seu servidor.
2. Configure seu servidor web para servir a partir da pasta public/ . Veja aqui para obter informações adicionais.
3. Copie o arquivo de configuração global cp .env .env.local e edite .env.local :
   • Altere a linha APP_ENV=dev para APP_ENV=prod
   • Se você não quiser usar SQLite, altere o valor de DATABASE_URL= conforme sua necessidade (veja aqui) para o formato. Em instâncias maiores com acessos simultâneos, o MySQL tem melhor desempenho. Isso não pode ser alterado facilmente posteriormente, então escolha com sabedoria.
4. Instale dependências do compositor e gere arquivos de carregamento automático: composer install -o --no-dev
5. Instale dependências do lado do cliente e construa-as: yarn install e yarn build
6. Opcional (acelera o primeiro carregamento): Cache de aquecimento: php bin/console cache:warmup
7. Atualize o banco de dados para o novo esquema (ou crie-o, quando estiver vazio): php bin/console doctrine:migrations:migrate e siga as instruções fornecidas. Durante o processo, a senha do usuário administrador é mostrada. Copie. Cuidado : Essas etapas alteram seu banco de dados e podem destruí-lo. Portanto, certifique-se de fazer um backup do seu banco de dados.
8. Você pode configurar o Part-DB via config/parameters.yaml . Você deve verificar se as configurações correspondem às suas expectativas após instalar/atualizar o Part-DB. Verifique se partdb.default_currency corresponde à moeda usada principalmente (isso não pode ser alterado após a criação das informações de preço). Execute php bin/console cache:clear quando você alterar alguma coisa.
9. Acesse o Part-DB em seu navegador (na URL que você colocou) e faça login com o usuário admin . A senha é aquela gerada durante a configuração do banco de dados. Se você não consegue lembrar a senha, defina uma nova com php bin/console app:set-password admin . Você pode criar novos usuários com o usuário administrador e começar a usar o Part-DB.

Quando quiser atualizar para uma versão mais recente, basta copiar os novos arquivos para a pasta e repetir as etapas 4. a 7.

Normalmente, uma senha aleatória é gerada quando o usuário admin é criado durante a criação inicial do banco de dados, no entanto, você pode definir a senha admin inicial, definindo INITIAL_ADMIN_PW env var.

Você pode configurar o Part-DB de acordo com suas necessidades alterando as variáveis ​​de ambiente no arquivo .env.local . Veja aqui para mais informações.

Proxy reverso

Se você estiver usando um proxy reverso, deverá garantir que os proxies configurem os cabeçalhos X-Forwarded-* corretamente, ou você obterá uma confusão de HTTP/HTTPS e nomes de host errados. Se o proxy reverso estiver em um servidor diferente (ou não puder acessar o Part-DB via localhost), você deverá definir a variável env TRUSTED_PROXIES para corresponder ao endereço IP (ou bloco IP) do seu proxy reverso. Você pode fazer isso em seu .env.local ou (ao usar o docker) em seu arquivo docker-compose.yml .

Doe para o desenvolvimento

Se você quiser doar para o desenvolvedor do Part-DB, veja o botão patrocinador na barra superior (ao lado do nome do repositório). Lá você encontrará vários métodos para apoiar o desenvolvimento mensalmente ou uma vez.

Construído com

• Symfony 5: O principal framework usado para PHP serverside
• Bootstrap 5 e Bootswatch: usados ​​como tema do site
• Fontawesome: Usado como conjunto de ícones
• Estímulo Hotwire e Hotwire Turbo: Javascript Frontend

Autores

• Jan Böhmer - Trabalho inicial - GitHub

Veja também a lista de colaboradores que participaram deste projeto.

Baseado no Part-DB original de Christoph Lechner e K. Jacobs

Licença

Part-DB está licenciado sob a Licença Pública Geral GNU Affero v3.0 (ou na sua opinião, mais tarde). Isso significa principalmente que você pode usar o Part-DB para o que quiser (até mesmo usá-lo comercialmente), desde que publique o código-fonte para cada alteração feita na AGPL também.

Consulte LICENÇA para obter mais informações.