movyx-db-api-package v1.0.155
Documentação Técnica - movyx-db-api-package
Descrição
O "movyx-db-api-package" é uma dependência para conexão de banco de dados utilizada em outros serviços. Este pacote fornece funcionalidades para interagir com bancos de dados e executar migrações.
Instalação
Siga as instruções abaixo para instalar e utilizar o "movyx-db-api-package":
Pré-requisitos
Node.js instalado (versão 18.14.2 ou superior)
Gerenciador de pacotes npm instalado (geralmente vem com o Node.js)
Passos de instalação
Abra um terminal ou prompt de comando.
Navegue até o diretório do seu projeto.
Execute o seguinte comando para instalar o "movyx-db-api-package" como uma dependência:
npm install movyx-db-api-package
Utilização
Após instalar o "movyx-db-api-package", você pode utilizar suas funcionalidades no seu código. Aqui está um exemplo básico de como utilizar o pacote:
criar Model no local src/models/.ts utilizando o typeorm, exemplo:
import { Column, Entity, PrimaryGeneratedColumn } from "typeorm"; @Entity("users") export class User { @PrimaryGeneratedColumn() id: number; @Column({ type: "varchar" }) name: string; @Column({ type: "varchar", unique: true }) email: string; @Column({ type: "varchar" }) password: string; }
Conexão do Banco no local
src/database/data-source.ts
```typescript
import "../env";
import "reflect-metadata";
import { DataSource } from "typeorm";
const port = Number(process.env.DB_PORT);
const host = String(process.env.DB_HOST);
const username = String(process.env.DB_USER);
const password = String(process.env.DB_PASS);
const database = String(process.env.DB_NAME);
export const AppDataSource = new DataSource({
type: "mssql",
host,
port,
username,
password,
database,
entities: [`${__dirname}/../models/*.{ts,js}`],
migrations: [`${__dirname}/../migrations/*.{ts,js}`],
});```
Certifique-se de importar as funcionalidades adequadas do pacote de acordo com suas necessidades.
Comandos disponíveis
O "movyx-db-api-package" fornece alguns comandos úteis que podem ser executados através do npm scripts. Aqui estão os comandos disponíveis:
migration:generate: Gera migrações de banco de dados com base no arquivo "src/database/data-source.ts" e os coloca em "src/migrations/default". Para executar este comando, execute o seguinte comando no terminal:
npm run migration:generate
migration:run: Executa as migrações de banco de dados com base no arquivo "src/database/data-source.ts". Para executar este comando, execute o seguinte comando no terminal:
npm run migration:run
Suporte e Contribuição
Se você encontrar algum problema ou tiver alguma dúvida relacionada ao "movyx-db-api-package", sinta-se à vontade para abrir uma issue no repositório do projeto: link para o repositório.
Passo a passo
Para subir uma nova versão da dependência npm, siga os seguintes passos:
Atualize a versão no arquivo
package.json
: Abra o arquivopackage.json
do seu projeto e atualize a versão da dependência que deseja publicar. Existem diferentes formas de versionar pacotes npm, mas a versão mais comum segue a convenção SemVer (Semantic Versioning). A versão é definida na propriedade"version"
do arquivopackage.json
. Por exemplo, se a versão atual for"1.0.0"
, você pode atualizá-la para"1.1.0"
.
Faça o commit das alterações: Após atualizar a versão no arquivo
package.json
, faça um commit das alterações em seu sistema de controle de versão (como o Git). Certifique-se de incluir uma mensagem descritiva do commit para facilitar o acompanhamento das alterações.
Execute o comando
npm publish
: No terminal, navegue até o diretório do seu projeto, onde o arquivopackage.json
está localizado, e execute o comandonpm publish
. Isso enviará a nova versão do pacote para o registro npm.
Verifique a publicação: Após executar o comando
npm publish
, verifique se a dependência foi publicada com sucesso no registro npm. Você pode acessar a página do pacote no site npm (https://www.npmjs.com/package/movyx-db-api-package) e verificar se a nova versão está listada.
É importante mencionar que para publicar uma dependência npm, você precisará ter uma conta no npmjs.com e estar autenticado no seu computador usando o comando npm login
com as credenciais da sua conta npm.
Além disso, é uma boa prática realizar testes em sua dependência antes de publicá-la para garantir que tudo esteja funcionando corretamente. Certifique-se de testar sua dependência localmente ou em um ambiente de testes adequado para evitar problemas em projetos que dependem dela.
Contribuições são bem-vindas! Se você quiser contribuir para o projeto, envie um pull request no repositório.
Licença
O "movyx-db-api-package" é licenciado sob a licença ISC. Leia o arquivo LICENSE para mais informações.
Versionamento
O "movyx-db-api-package" segue o padrão de versionamento SemVer (Semantic Versioning).
Estrutura em Pastas
Movyx-DB-api: Pasta raiz do projeto.
dist: Pasta que contém os arquivos gerados após a compilação ou transpilação do código-fonte.
node_modules: Pasta que contém as dependências do projeto instaladas pelo gerenciador de pacotes, como o npm.
- src: Pasta que contém o código-fonte principal do projeto. - database: Pasta que contém os arquivos relacionados à conexão e configuração do banco de dados. - data-source.ts: Arquivo responsável por fornecer a fonte de dados para a aplicação. - migrations: Pasta que contém os arquivos de migração do banco de dados, utilizados para modificar a estrutura da tabela ou adicionar/remover colunas. - models: Pasta que contém os modelos ou classes que representam as tabelas do banco de dados. - Address.ts: Modelo para a tabela de endereços. - Protocol.ts: Modelo para a tabela de protocolos. - SatPlatform.ts: Modelo para a tabela de plataformas SAT. - SatUser.ts: Modelo para a tabela de usuários SAT. - User.ts: Modelo para a tabela de usuários. - Vehicles.ts: Modelo para a tabela de veículos.
index.ts: Arquivo principal que inicia a aplicação e configura a conexão com o banco de dados.
.gitignore: Arquivo que especifica quais arquivos/diretórios devem ser ignorados pelo controle de versão Git.
package.json: Arquivo de manifesto do projeto que contém informações sobre as dependências e scripts do projeto.
package-lock.json: Arquivo gerado automaticamente pelo npm que registra as versões exatas das dependências instaladas.
README.md: Arquivo de documentação que fornece informações sobre o projeto, como instruções de instalação, uso e configuração.
tsconfig.json: Arquivo de configuração do TypeScript que define as opções de compilação/transpilação.
Conclusão
A documentação acima fornece uma visão geral da dependência "movyx-db-api-package" e explica como instalá-la. Você pode personalizar e adicionar mais detalhes conforme necessário, dependendo das funcionalidades específicas e dos requisitos do seu projeto. Certifique-se de manter a documentação atualizada à medida que o pacote evolui e novas versões são lançadas.
9 months ago
9 months ago
1 year ago
1 year ago
1 year ago
12 months ago
1 year ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago