Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/padupe/desafio_softaliza-nodejs
API baseada Nodejs com base na proposta do Desafio para Contratação de Desenvolvedor Back-End Júnior na Sotftaliza.
https://github.com/padupe/desafio_softaliza-nodejs
Last synced: 11 days ago
JSON representation
API baseada Nodejs com base na proposta do Desafio para Contratação de Desenvolvedor Back-End Júnior na Sotftaliza.
- Host: GitHub
- URL: https://github.com/padupe/desafio_softaliza-nodejs
- Owner: padupe
- Created: 2021-07-15T14:33:35.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-07-19T20:48:09.000Z (over 3 years ago)
- Last Synced: 2024-10-05T10:41:24.868Z (about 1 month ago)
- Language: JavaScript
- Size: 12.4 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Desafio [Softaliza](https://softaliza.com.br/ 'Softaliza') Nodejs
API baseada em **Nodejs** com base na proposta do Desafio para Contratação de **Desenvolvedor Back-End Júnior** na Sotftaliza.
## Tecnologias Aplicadas
---
> _Em ordem alfabética_
- [Docker](https://www.docker.com/ 'Docker'): "Contêinirização"
- [Express](https://expressjs.com/ 'Express'): Framework
- [Nodejs](https://nodejs.org/en/ 'Nodejs'): Eventos voltados para o Backend
- [Prisma](https://www.prisma.io/ 'Prisma'): ORM responsável pela Conexão com o Banco de Dados
- [PostgreSQL](https://www.postgresql.org/ 'PostgreSQL'): Sistema Gerenciador do Banco de Dados
## Dependências
---
> _Em ordem alfabética_
- [bcrypt](https://www.npmjs.com/package/bcrypt 'bcrypt'): Biblioteca para realizar _hash_ de senhas.
- [cross-env](https://www.npmjs.com/package/cross-env 'cross-env'): Módulo que permite executar scripts que definem e usam variáveis de ambiente.
- [ESLint](https://eslint.org/ 'ESLint'): "Corretor" de erros de Código/Sintaxe).
- [Jest](https://jestjs.io/ 'Jest'): Estrutura de testes de JavaScript.
- [jsonwebtoken](https://www.npmjs.com/package/jsonwebtoken 'jsonwebtoken'): Módulo de Autenticação para Segurança da Aplicação.
- [nodemon](https://www.npmjs.com/package/nodemon 'nodemon'): Ferramenta que reinicia automaticamente o servidor quando mudanças são detectadas.
- [Prettier](https://prettier.io/ 'Prettier'): "Formatador" de Código
- [SuperTest](https://www.npmjs.com/package/supertest 'SuperTest'): Módulo para testes de Integração.
- [slugify](https://www.npmjs.com/package/slugify 'slugify'): Módulo para gerar _slugs_ automaticamente.
- [uuidv4](https://www.npmjs.com/package/uuidv4 'uuidv4'): Módulo para criar UUID (_Universally Unique IDentifier_) conforme [RFC1422].
- [winston](https://www.npmjs.com/package/winston 'winston'): Biblioteca para o registro de logging de Aplicações.
## MER (Modelo Entidade Relacionamento)
---
## Modelos de JSON para uso na Aplicação
---
**DICA:** Para facilitar as os testes utilizando o [Insomnia](https://insomnia.rest/ 'Insomnia'), crie uma "Enviroment":
```json
{
"baseurl": "localhost:2121/v1"
}
```
> Para utilizar a "Enviroment", na barra de endereços utilize as teclas **Ctrl+Espaço**
### Login na Aplicação
#### Auth
- Login
Usuário Válido:
```json
{
"username": "paulopeixoto",
"password": "softaliza@2021"
}
```
> **ATENÇÃO:** Após logar na Aplicação, será necessário "guardar" o Token gerado para prosseguir nos demais endpoints
Teste utilizando o Insomnia:
---
#### BlogPost
- POST (_Para criar um BlogPost_)
Exemplo de "Novo" Post:
> Inserir na barra do Insomnia
```
localhost:2121/v1/blogpost/
```
JSON de "carga":
```json
{
"username": "paulopeixoto",
"title_post": "A New Post.",
"content_post": "Example"
}
```
> **IMPORTANTE:** Os três campos são obrigatórios.
**Retorno esperado:**
```json
{
"post": {
"user": {
"username": "paulopeixoto"
},
"title": "A New Post.",
"content": "Example"
},
"msg": "New Post Created!"
}
```
Teste utilizando o Insomnia:
---
- GET (_Exibir um BlogPost pelo slug_)
Exemplo de consulta:
> Inserir na barra do Insomnia
```
localhost:2121/v1/blogpost/the-history-of-my-life
```
**Retorno esperado:**
```json
{
"post": {
"user": {
"username": "paulopeixoto"
},
"title": "The history of my life!",
"content": "Summary of my professional trajectory",
"slug": "the-history-of-my-life"
},
"msg": "Show Post Successful!"
}
```
Teste utilizando o Insomnia:
---
- PUT (_Para atualizar um BlogPost_)
Exemplo de Atualização de um Post:
> Inserir na barra do Insomnia
```
localhost:2121/v1/blogpost/the-history-of-my-life
```
JSON de "carga":
```json
{
"new_title": "Update Post",
"new_content": "Example"
}
```
> **IMPORTANTE:** Os dois campos são obrigatórios.
**Retorno esperado:**
```json
{
"post": {
"user": {
"username": "paulopeixoto"
},
"title": "Update Post",
"content": "Example"
},
"msg": "Update Post Successful!"
}
```
Teste utilizando o Insomnia:
---
- DELETE (_Para deletar um BlogPost_)
Exemplo de Exclusão de um Post:
> Inserir na barra do Insomnia
```
localhost:2121/v1/blogpost/why-did-i-choose-to-be-back-end
```
**Retorno esperado:**
```json
{
"user": "paulopeixoto",
"msg": "Delete Post Successful!"
}
```
Teste utilizando o Insomnia:
---
## Comandos úteis para uso da Aplicação
---
### Developmente Server
Iniciar o servidor da Aplicação:
```
$ npx yarn dev
```
### Docker
Subir as configurações do contêiner:
```
$ docker-compose -f docker/docker-compose.yml up -d
```
### PostgreSQL (Banco de Dados) / ORM Prisma
Interface Visual no navegador para acessar o Banco de Dados:
```
$ npx prisma studio
```
Iniciar Migration:
```
$ npx yarn migrate
```
Carregar os dados de teste no Banco:
```
$ npx yarn seed
```
Realizar o _reset_ das Migrations e limpar o Banco de Dados:
```
$ npx yarn reset
```
> _**Atenção:** Após utilizar o comando "reset" será necessário rodar o comando '$ npx yarn seed'._
---
## Testes
Comando para rodar todos os testes:
```
$ npx yarn test
```
> _**Atenção:** Após utilizar o comando '$ npx yarn test' a base do Banco de Dados será "limpa" e "populada" novamente de maneira automática._
### Testes de Integração
Comando para testar o arquivo **auth.test.js** (_diretório routes_) :
```
$ npx yarn test routes/auth.test.js
```
Comando para testar o arquivo **blogpost.test.js** (_diretório routes_) :
```
$ npx yarn test routes/blogpost.test.js
```
---
### Testes Unitários
Comando para testar o arquivo **crypt.test.js** (_diretório utilities_) :
```
$ npx yarn test utilities/crypt.test.js
```
Comando para testar o arquivo **findPost.test.js** (_diretório controllers/blogPost_) :
```
$ npx yarn test controllers/blogPost/findPost.test.js
```
Comando para testar o arquivo **findUsername.test.js** (_diretório controllers_) :
```
$ npx yarn test controllers/findUsername.test.js
```
Comando para testar o arquivo **token.test.js** (_diretório auth_) :
```
$ npx yarn test auth/token.test.js
```
---
### Coverage
Comando para validar o coverage:
```
$ npx yarn test --coverage
```
---
## Logging
| Level | Observação |
| :---: | :------------------------: |
| info | Teste |
| debug | Dados do Usuário |
| error | Erros de Banco / Aplicação |
---
_Aplicação desenvolvida por [Paulo Eduardo Peixoto](https://www.linkedin.com/in/paulo-eduardo-peixoto-2155a866/ 'Paulo Eduardo Peixoto')_
[//]: #
[rfc1422]: https://www.ietf.org/rfc/rfc4122.txt