ramonfsk/valoriza-api

Projeto desenvolvido na missão NodeJS no NLW #06

Valoriza-API

---

Cadastre elogios para outros usuários por meio de tags.

📝 Tabela de Conteúdo

• Regras de Negócio
• Iniciando o Projeto
• Ferramentas Utilizadas
• Aprendizados

🏁 Iniciando o Projeto

Aqui são algumas instruções para que você consiga rodar o projeto localmente e consiga utilizá-lo.

Pré-Requisitos

Certifique-se de que você possui a versão LTS do node e um dos gerenciadores de pacote (yarn ou NPM) instalados.

Eu utilizei yarn, mas o processo é bem parecido para o NPM.

node -v
yarn -v
npm -v

Instalando

Faça o download do projeto em sua máquina e rode o comando com yarn para instalar as dependências

yarn
npm i

Aguarde até que todas as dependências sejam instaladas e a pasta node_modules apareça.

Running

Para rodar a aplicação na porta 3000, utilize o comando:

yarn dev 

🧐 Regras de Negócio

Cadastro de Usuários

• 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 cadastro de tags por usuários que não sejam administradores

Cadastro de Elogios

• Não é permitido que o usuário cadastre um elogio para si
• Não é permitido cadastrar elogios para usuários inexistentes ou inválidos
• Usuário precisa estar autenticado na aplicação para cadastrar elogios

⛏️ Ferramentas Utilizadas

• SQLite - SQLite
• Express - Server Framework
• NodeJs - Server Environment (Versão LTS)
• TypeORM - TypeORM
• Yarn - Yarn
• Typescript - Typescript
• JWT - JsonNWebToken
• Class Transformer - ClassTransformer

🎉 Aprendizados

• Princípios de Solid
• Autenticação com JWT
• Utilização do typeorm
• Construção de API Node com Typescript
• Utilização de SQLite
• Utilização da biblioteca class-transformer