👥 Users Crud 👥

Sobre o Projeto • Endpoints • Instalação • Utilização • Tecnologias • Autor

🖥️ Sobre o Projeto

Projeto desenvolvido como parte das atividades do curso da Kenzie Academy Brasil.

Esse projeto consiste em uma aplicação back-end com um CRUD básico de usuários.

O objetivo do desenvolvimento desse projeto era praticar e aprimorar as habilidades em Node.js, Express.js e TypeORM.

Esse serviço possui uma API REST integrada a um banco de dados PostegreSQL.

Através dessa aplicação, um usuário pode se cadastrar, fazer login, atualizar seus dados, listar todos os usários cadastrados e remover um usuário.

💡 Endpoints

Método	Endpoint	Responsabilidade
POST	/users	Cria um usuário
POST	/login	Gera um token JWT recebendo email e password no corpo da requisição como JSON.
GET	/users	Lista todos os usuários
GET	/users/profile	Retorna os dados do usuário logado (usuário a qual pertence o token que será necessário neste endpoint)
PATCH	/users/<uuid>	Atualiza os dados de um usuário
DELETE	/users/<uuid>	Deleta usuários do banco

⚙️ Instalação

Este projeto requer que o Git, o Node.js e o Docker estejam instalados em sua máquina.

• Faça o fork desse repositório.

• Abra o terminal e clone o repositório:

$ git clone [email protected]:<your_user>/users-crud.git

• Entre no diretório do projeto:

$ cd users-crud

• Instale as dependências:

$ yarn install

• Adicione o arquivo .env na raiz do projeto e configure suas variáveis de ambiente seguindo o modelo do arquivo .env.example):

POSTGRES_USER=your_username
POSTGRES_PASSWORD=your_password
POSTGRES_DB=your_database
JWT_SECRET=your_secret_key

• Inicie o contêiner docker referente ao banco de dados PostgreSQL de acordo com as configurações do arquivo docker-compose.yml:

$ docker-compose up

• Execute as migrations para criar as tabelas no banco de dados:

$ yarn typeorm migration:run

• Execute a aplicação:

$ yarn dev

Pronto! A aplicação, agora, estará sendo executada através na rota https://localhost:3000/.

🚀 Utilização

Para utilizar a aplicação, é necessário o uso de uma API Client, como Postman ou Insomnia.

Verifique a documentação da API.

🛠️ Tecnologias

Para o desenvolvimento desse projeto, as seguintes ferramentas foram utilizadas:

• Node.js
• Express.js
• TypeScript
• TypeORM
• Docker
• Bcrypt
• JSON Web Token
• Yup

👨‍💻 Autor

Marcos Kenji Kuribayashi

---

Desenvolvido por Marcos Kenji Kuribayashi 😉