https://github.com/patrickmoraisn/valoriza-server
Sistema de elogio para equipes
https://github.com/patrickmoraisn/valoriza-server
express jwt-auth nodejs postgresql prettier-eslint typeorm typescript
Last synced: 3 months ago
JSON representation
Sistema de elogio para equipes
- Host: GitHub
- URL: https://github.com/patrickmoraisn/valoriza-server
- Owner: PatrickMoraisN
- Created: 2021-12-06T17:26:59.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-12-07T23:07:40.000Z (over 4 years ago)
- Last Synced: 2025-07-04T18:49:15.779Z (about 1 year ago)
- Topics: express, jwt-auth, nodejs, postgresql, prettier-eslint, typeorm, typescript
- Language: TypeScript
- Homepage:
- Size: 298 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# :pushpin: Índice
- [Banco de Dados](#package-banco-de-dados)
- [Regras da Aplicação](#scroll-regras-da-aplicação)
- [Rotas](#mailbox_closed-Rotas)
- [Mídia](#camera_flash-mídia)
- [Sobre](#monocle_face-sobre)
- [Tecnologias](#rocket-tecnologias)
- [Instalação](#hammer_and_wrench-instalação)
- [Autor](#closed_book-autor)
---
# :package: Banco de Dados
O Banco de dados utilizado foi o PostgreSQL com TypeORM.
Para monitoramento foi utilizado o Beekeeper.
A estrutura dos dados ficou desenhada dessa forma:
---
# :scroll: Regras da Aplicação
- ### Cadastro de Usuário
- Não é permitido cadastrar mais de um usuário com o mesmo email.
- Não é permitido cadastrar um usuário sem email.
- ### Cadastro de Tags
- Não é permitido cadastrar mais de uma tag com o mesmo nome.
- Não é permitido cadastrar uma tag sem nome.
- Não é permitido o cadastro de uma tag por usuários que não sejam administradores.
- O usuário precisa estar autenticado na aplicação.
- ### Cadastro de Elogios
- Não é permitido um usuário cadastrar um elogio para si.
- Não é permitido um usuário cadastrar um elogio para usuário inválidos.
- O usuário precisa estar autenticado na aplicação.
---
# :mailbox_closed: Rotas
- ### Post
`/users` Registra um novo usuário.
`/tags` Registra uma nova tag (Precisa ser administrador.
`/login` Loga na aplicação e gera um token JWT.
`/compliments` Registra um novo elogio para um usuário. (Precisa estar autenticado.)
- ### Get
`/users/compliments/send` Lista elogios que o usuário logado enviou (Precisa estar autenticado).
`/users/compliments/received` Lista elogios que o usuário logado recebeu (Precisa estar autenticado).
`/tags` Lista todas as tags (Precisa estar autenticado).
`/users` Lista todos os usuários (Precisa estar autenticado).
---
# :camera_flash: Mídia
Aqui alguns exemplos de respostas das requisições que podem ser feitas:
- Criar uma tag
- Listar todos os usuários
***OBS*** _Nessa resposta da requisição foi utilizado o decorator Exclude() da biblioteca `class-transformer` para retirar o campo `password` da resposta. Legal né!?_
- Criar um usuário
***OBS*** _O campo `id` foi gerado pela biblioteca `uuid` usando o tipo de hash aleatória `v4`_
---
# :monocle_face: Sobre
Esse projeto foi feito com a intenção de praticar Node utilizando Typescript com PostgreSQL e TypeORM.
Para tratar a senha recebida na criação de um usuário, foi utilizado a biblioteca `bcryptjs`.
Um middleware para confirmar se o usuário logado é administrador foi criado.
A verificação do token JWT também é feita pelo middleware, sendo o `id` do usuário logado resgatado do próprio payload do token.
Espero que tenha gostado :)
---
# :rocket: Tecnologias
Esse projeto foi feito utilizando as seguintes tecnologias:
- :heavy_check_mark: **Node**
- :heavy_check_mark: **Express**
- :heavy_check_mark: **Typescript**
- :heavy_check_mark: **TypeORM**
- :heavy_check_mark: **PostgreSQL**
- :heavy_check_mark: **JWT Auth**
- :heavy_check_mark: **bcryptjs / class-transformer**
- :heavy_check_mark: **ESLint**
- :heavy_check_mark: **Prettier**
---
# :hammer_and_wrench: Instalação
**Esse projeto envolve variáveis ambientes, tenha certeza de que você as possui antes de tentar executar!**
1. Clone o repositório
```bash
git clone git@github.com:PatrickMoraisN/valoriza-server.git
```
2. Mude para o diretório do repositório
```bash
cd valoriza-server
```
3. Instale as dependências
```bash
npm install
```
4. Crie um arquivo `.env` na raíz do seu projeto e adicione as variáveis ambientes
***OBS*** Necessário ter instalado o PostgreSQL na máquina!
```bash
### JWT
JWT_SECRET=b09879245dc798a8f22f44d77f78861fae9e39b9
### PostgreSQL
POSTGRE_USER=seu-usuario-postgre
POSTGRE_PASS=sua-senha-postgre
POSTGRE_DATABASE=nome-do-seu-banco-de-dados
POSTGRE_PORT=porta-do-banco-de-dados
```
5. Rode as Migrations
```bash
npx -p typeorm ts-node-dev ./node_modules/typeorm/cli.js migration:run
```
6. Inicie o app
```bash
npm run dev
```
Tá tudo pronto! O servidor está online em [localhost:3000](http://localhost:3000/)!
---
# :closed_book: Autor
Patrick Morais
[](https://www.linkedin.com/in/patrick-morais/)
[](mailto:ppternunes@gmail.com)
[](https://www.github.com/patrickmoraisn/)