Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/4lessandrodev/microservice
template for microservice
https://github.com/4lessandrodev/microservice
message-broker microservice nestjs nodejs rabbitmq template
Last synced: 3 months ago
JSON representation
template for microservice
- Host: GitHub
- URL: https://github.com/4lessandrodev/microservice
- Owner: 4lessandrodev
- Created: 2022-09-03T16:39:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-11T12:02:02.000Z (10 months ago)
- Last Synced: 2024-04-28T07:22:30.025Z (9 months ago)
- Topics: message-broker, microservice, nestjs, nodejs, rabbitmq, template
- Language: TypeScript
- Homepage:
- Size: 2.64 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Template - Microservice
Este template possui comandos automatizados para gerar componentes para a construção do backend.
Os comandos podem ser executados com:
- `yarn`
- `npm`
---
Este microservice utiliza o conceito de Message Broker
---
## Como utilizar a cli
Antes de tudo instale as dependências
```sh
$ yarn
```
Utilizando a cli com yarn
```sh
$ yarn types-ddd
```
Utilizando a cli com npm
```sh
$ npm run types-ddd
```
---
## Gerenciador de pacotes
Para instalar e gerenciar novos pacotes (libs) utilize yarn.
Dependência de produção
```sh
$ yarn add
```
Dependência de desenvolvimento
```sh
$ yarn add -D
```
---
## Alias Path
Este template já possui um alias global `@modules` e `@shared` configurado
- `@modules/*` aponta para o caminho `src/modules/*`
- `@shared/*` aponta para o caminho `src/shared/*`
Para adicionar novos alias siga o modelo nos arquivos:
- `tsconfig.json`
- `jest-e2e.json`
- `jest.config.json`
A inclusão deve ser feita em todos esses 3 arquivos.
---
## Scripts
Testes.
Executar testes unitários.
obs: Os teste unitários devem ter o padrão de nome `.spec.ts`
```sh
$ yarn test
```
Executar testes de integração.
obs: Os teste de integração devem ter o padrão de nome `.test.ts`
```sh
$ yarn test:e2e
```
Executar a aplicação em watch mode
```sh
$ yarn start:dev
```
Executar a aplicação
```sh
$ yarn start
```
Para verificar se a aplicação está ok.
Esta aplicação é um microservice que se conecta ao broker message do rabbitmq.
Para subir um broker utilize o docker-compose
```sh
$ docker-compose up -d
```
Acesse o broker
```
GET http://localhost:15672/
```
Verificar se a aplicação se conectou com o broker
Acesse o painel
---
## Variáveis
As variáveis de ambiente devem ser definidas no arquivo
`src/shared/env.ts`
Após definir as variáveis no env.ts você pode definí-las no arquivo .env
---
## Commits
Os commits devem seguir a convenção do commit lint
```sh
[optional scope]:
[optional body]
[optional footer(s)]
```
- `feat`: nova feature
- `build`: mudanças que afetam o processo de build
- `chore`: instalação de lib, ou configuração de ferramentas
- `ci`: configuração de script ou processos do pipeline
- `docs`: atualização de documentação
- `style`: mudanças que afetam o estilo do código, formatação etc
- `refactor`: alteração ou melhoria de código que não seja bug ou feature
- `perf`: melhorias de código que melhoram a performance
- `test`: adicionado testes ou correção de algum
Exemplo:
```sh
$ git commit -m "test (payment): ensure payment confirmation"
```