🏪 Kenzie Market 🏪

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 de um marketplace.

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.

Algumas funcionalidades dessa aplicação são:

• Usuário administrador pode:
  • Cadastrar e gerenciar o estoque de produtos
  • Vender produtos na plataforma
  • Fazer o acompanhamento de vendas
• Usuário cliente pode:
  • Registrar-se na plataforma
  • Fazer um carrinho de compras
  • Receber um e-mail com os itens e valores comprados
  • Recuperar sua senha de acesso

💡 Endpoints

Método	Endpoint	Responsabilidade	Regras de Negócio
POST	/user	Cria um usuário	Um usuário pode ser do tipo cliente ou do tipo administrador. Use uma propriedade booleana que faça essa diferenciação
GET	/user/<userId>	Seleciona um determinado usuário pelo id	Usuários do tipo cliente são restritos as suas próprias informações. Ou seja: um cliente não pode selecionar outro usuário além dele mesmo, mas um administrador pode selecionar qualquer usuário do sistema
GET	/user	Seleciona todos os usuários	Apenas os administradores podem fazer essa ação
POST	/login	Gera um toke de autenticação	Login via e-mail e password
POST	/product	Cadastra um único produto	Apenas usuário do tipo administrador pode realizar essa asção
GET	/product/<productId>	Seleciona um determinado produto pelo id	Qualquer usuário pode realizar essa ação
GET	/product	Seleciona todos os produtos cadastrados	Qualquer usuário pode realizar essa ação
POST	/cart	Adiciona um produto no carrinho	Apenas usuários logados devem adicionar o produto no carrinho
GET	/cart/<cartId>	Seleciona o carrinho do usuário	Usuários do tipo cliente são restritos as suas próprias informações. Ou seja: um cliente não pode selecionar o carrinho de outro usuário, mas um administrador pode selecionar qualquer carrinho do sistema
GET	/cart	Seleciona todos os carrinhos	Apenas os administradores podem realizar essa ação
DELETE	/cart/<productId>	Deleta um produto do carrinho	Apenas o usuário dono do carrinho e o administrador pode realizar essa ação
POST	/buy	Realiza compra dos produtos do carrinho	Apenas o dono do carrinho pode finalizar uma compra e após a sua finalização um email com os dados da compra deve ser disparado para o usuário
GET	/buy/<orderId>	Seleciona uma compra já realizada	Apenas o usuário dono da compra e o administrador pode realizar essa ação
GET	/buy	Seleciona todas as compras já realizadas	Apenas o administrador pode realizar essa ação
POST	/email	Envia um email qualquer para um determinado usuário	Caso o administrador queira mandar alguma mensagem para um usuário qualquer. Apenas o administrador pode realizar essa ação
POST	/recover	Envia um código de validação para o email do usuário	O sistema deverá gerar um código validador qualquer na qual será usado para a recuperação de senha
POST	/change_password	Altera a senha do usuário	A partir do código validador que o usuário recebe em seu email, o usuário pode alterar a senha mandando no body da requisição o codigo, a nova senha e sua confirmação

⚙️ 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>/kenzie-market_back.git

• Entre no diretório do projeto:

$ cd kenzie-market_back

• 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):

JWT_SECRET=JWT secret key for generate token JWT
DATABASE_URL=URL for database connection after deploy
GMAIL_EMAIL=E-mail of gmail account to send emails
GMAIL_PASSWORD=Password of gmail account to send emails
POSTGRES_USER=Database user
POSTGRES_PASSWORD=Password for database
POSTGRES_DB=Database

Se você usa a verificação em duas etapas na sua conta do Google, habilite uma senha de app aqui e a insira como valor da variável GMAIL_PASSWORD

• 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 em http://localhost:3000/.

🚀 Utilização

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

Acesse e siga a documentação em http://localhost:3000/api-documentation e faça as requisições na aplicação utilizando uma API Client.

🛠️ Tecnologias

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

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

👨‍💻 Autor

Marcos Kenji Kuribayashi

---

Desenvolvido por Marcos Kenji Kuribayashi 😉