NLW Valoriza

Sobre o projeto   |    Tecnologias   |    Recursos   |    Evolução do projeto   |    Licença

🚀 Sobre o projeto

Foi construído uma API para gerenciamento de elogios usando Node.js, no qual além das rotas principais de cadastro de Uusários, Tags e Elogios, também foi desenvolvido uma rota para autenticação e para validação do perfil do usuário.

🔧 Tecnologias

• Node.js
• Express.js
• TypeORM
• JWT

Aplicação criada baseada no desafio de Node.js disponibilizado pela Rocketseat durante a Next Level Week.

🔗 Recursos

Usuário

GET - /users - Listar todos os usuários

Auth:

Params	Type
token	JWT

Response:

Params	Type
id	string
name	string
email	string
admin	boolean
created_at	date
updated_at	date

POST - /users - Criar um novo usuário

Request Body:

Params	Type	Required
name	string	x
email	string	x
password	string	x
admin	string

Response:

Params	Type
id	string
name	string
email	string
admin	boolean
created_at	date
updated_at	date

POST - /login - Autenticação de usuário

Request Body:

Params	Type	Required
email	string	x
password	string	x

Response:

Params	Type
token	string

Tags

GET - /tags - Listar todas as tags

Auth:

Params	Type
token	JWT

Response:

Params	Type
id	string
name	string
created_at	date
updated_at	date
name_custom	string

POST - /tags - Criar uma nova tag

Auth:

Params	Type
token	JWT

Request Body:

Params	Type	Required
name	string	x

Response:

Params	Type
id	string
name	string
created_at	date
updated_at	date

Elogios

GET - /users/compliments/receive - Listar todos os elogios recebidos

Auth:

Params	Type
token	JWT

Response:

Params	Type
id	string
user_sender	string
user_receiver	string
tag_id	string
message	string
created_at	date
userSender	object
userReceiver	object

userSender => propriedades do usuário que enviou o elogio userReceiver => propriedades do usuário que receber o elogio

GET - /users/compliments/send - Listar todos os elogios enviados

Auth:

Params	Type
token	JWT

Response:

Params	Type
id	string
user_sender	string
user_receiver	string
tag_id	string
message	string
created_at	date
userSender	object
userReceiver	object

userSender => propriedades do usuário que enviou o elogio userReceiver => propriedades do usuário que receber o elogio

POST - /compliments - Criar um novo elogio

Auth:

Params	Type
token	JWT

Request Body:

Params	Type	Required
tag_id	string	x
user_receiver	string	x
message	string	x

Response:

Params	Type
id	string
user_sender	string
user_receiver	string
tag_id	string
message	date
created_at	date

💡 Evolução do projeto (em processo)

• Criar um Error handle para capturar os nossos erros;
• Implementar TDD;
• Alerta de e-mail para o usuário que receber um elogio;
• Autenticação por meio de login social;
• Implementar front-end.

📝 Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

---

Feito por Elen Magalhães - Projeto em desenvolvimento