Sobre • Funcionalidades • Rotas • Como executar • Tecnologias • Autor
📃 E-commerce - É uma mini plataforma online de compras, onde você pode escolher seus produtos e "compra-los".
- Criar um usuário
- nome do usuário
- email do usuário
- senha do usuário
- Adicionar um produto ao carrinho
- Editar um produto no carrinho
- Remover um produto do carrinho
- Ver seu carrinho de compras
- Finalizar um carrinho de compras
- Ver seu histórico de compras
- users
-
- post /users → Criar um novo usuário.
- auth
-
- post / → Fazer login
-
- get /me → Pegar informações do usuário autenticado
- products
-
- get /proddcts → Listar todos os produtos
-
- post /products → Criar um novo produto
- carts
-
- **get /carts ** → Pegar as informações do carrinho do usuário autenticado
-
- patch /carts/add-products → Adicionar novos produtos no carrinho
-
- patch /carts/remove-products → Remover a quantidade de um produto no carrinho
-
- patch /carts/remove-cart-items → Remover um determinado produto do carrinho
-
- patch /carts/confirm → Confirmar compra do carrinho
- sales
-
- get /sales → Listar histórico de compras
- Este projeto usa o PostgresSQL como Banco de Dados, então você precisa configurar o seu banco:
- No arquivo src/database/index.ts é onde é feita a configuração do PostgresSQL.
- Você pode mudar as configurações de acordo com a sua necessidade.
- Ou você pode subir um ambiente Docker na porta 5432, e rodar os camandos SQLs que estão dentro de src/database/schema.sql
Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js. Além disto é bom ter um editor para trabalhar com o código como VSCode
# Clone este repositório
$ git clone https://github.com/cmarciao/e-commerce-backend
# Acesse a pasta do projeto no seu terminal/cmd
$ cd e-commerce-backend
# Instale as dependências
$ yarn
# Execute a aplicação em modo de desenvolvimento
$ yarn dev
# A aplicação será aberta na porta:3333 - acesse http://localhost:3333
As seguintes ferramentas foram usadas na construção do projeto:
Server (NodeJS + TypeScript)
Veja o arquivo package.json
- Editor: Visual Studio Code
- Teste de API: Insomnia
Cássio Marcião