README-PTBR.md

O OURO DOS MANTOS - E-COMMERCE DE CAMISAS DE FUTEBOL

Don't speak Portuguese? Click here. I also wrote this README in English!

Funcionalidades | Tecnologias usadas | Primeiros passos | API Endpoints | Contribua

Funcionalidades

funcionalidade	status	descrição
Login com a conta do Google	⬜	Usando VueFire.
Botão de detalhes do perfil do usuário	⬜	Usuários autenticados com a conta do Google podem ver sua imagem e nome de usuário na barra superior da aplicação web ou na barra lateral da aplicação mobile, transição criada com o composable useBreakpoint.
em breve	⬜	em breve

Tecnologias usadas

• NuxtJS
• VueFire
• Pinia
• Prisma
• PostgreSQL
• NeonDB
• TypeScript
• TailwindCSS
• Shadcn-vue

Primeiros passos

Como rodar o projeto na sua máquina...

Pré-requisitos

• NodeJS
• Git

Clonando

git clone https://github.com/laysaalves/ourodosmantos-ecommerce.git

Configurando o .env

Use o .env.example como referência para criar o seu .env com as suas chaves

VUEFIRE_API_KEY={YOUR_SECRET_KEY}

Começando

cd ourodosmantos-ecommerce
yarn // ou seu gerenciador de pacotes preferido para instalar as dependências

API Endpoints

Em breve! Apenas exemplos aqui por enquanto. ​

rota	descrição
GET /products	recupera informações do produto, veja detalhes da resposta
POST /authenticate	autentica o usuário na API, veja detalhes da requisição

GET /products

RESPOSTA

{
  "name": "Camisa Vasco da Gama Casa 23/24",
  "price": 300,
  "discountPercentage": 0,
}

POST /authenticate

REQUISIÇÃO

{
  "username": "leonardojardim",
  "email": "leojardim@colina.com"
}

RESPOSTA

{
  "token": "OfoMRHsaQwyAgVoc3OXmL1JhMVUYACGBbCTK0GBgiYitwSwjf0gVoBmkbuyy0pSk"
}

Contribua

1. git clone https://github.com/laysaalves/ourodosmantos-ecommerce.git
2. git checkout -b feature/feature-name
3. Siga o padrão de commit
4. Abra um pull request para explicar o problema resolvido ou a funcionalidade feita e se houver necessidade, acrescente a captura de tela das modificações visuais e aguarde a revisão

Documentações que podem ajudar

Padrão de commit