O OURO DOS MANTOS - SOCCER T-SHIRTS E-COMMERCE

Não lê em Inglês? Clique aqui. Eu também fiz esse README em Português!

Features | Used technologies | Getting Started | API Endpoints | Contribute

Features

feature	status	description
Login with Google Account	⬜	Using VueFire.
Profile details button	⬜	Users authenticated with Google Account can see their image and username in the topBar of web app or sideBar of mobile app, a transition created with the composable useBreakpoint.
soon	⬜	soon

Used technologies

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

Getting started

How to run the project locally...

Prerequisites

• NodeJS
• Git

Cloning

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

Config .env variables

Use the .env.example as reference to create your configuration file .env with your keys

VUEFIRE_API_KEY={YOUR_SECRET_KEY}

Starting

cd ourodosmantos-ecommerce
yarn // or your preferred package manager to install dependencies

API Endpoints

Soon! Only boilerplate for now. ​

route	description
GET /products	retrieves product info see response details
POST /authenticate	authenticate user into the api see request details

GET /products

RESPONSE

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

POST /authenticate

REQUEST

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

RESPONSE

{
  "token": "OfoMRHsaQwyAgVoc3OXmL1JhMVUYACGBbCTK0GBgiYitwSwjf0gVoBmkbuyy0pSk"
}

Contribute

1. git clone https://github.com/laysaalves/ourodosmantos-ecommerce.git
2. git checkout -b feature/feature-name
3. Follow commit patterns
4. Open a Pull Request explaining the problem solved or feature made, if exists, append screenshot of visual modifications and wait for the review!

Documentations that might help

Commit pattern