PetExpress API v1.1.0 🐾

Estamos empolgados em anunciar uma nova atualização da PetExpress API! Esta versão aprimora e expande a funcionalidade da API de Petshop, adicionando recursos de gerenciamento de pets, produtos, carrinho de compras, agendamentos, endereços e autenticação JWT. A API segue uma estrutura modular, inspirada no NestJS, desenvolvida com Node.js e Sequelize para facilitar a manutenção e a escalabilidade.

🚀 Funcionalidades

Funcionalidades Básicas

• Pets: Cadastro, edição e exclusão, com limite de 15 pets por usuário e validações customizadas.
• Produtos: Gerenciamento completo de produtos, com classificação por categorias e espécies.
• Endereços: Até 3 endereços por usuário, com controle de unicidade para cada entrada.
• Carrinho e Pedidos: Carrinho de compras com cálculo automático de total e criação de pedido após confirmação de pagamento.

Funcionalidades avançadas

• Login com Google e Cadastro Automático: Após a autenticação com Google pelo Firebase no front-end, a API verifica se o email já está registrado. Se não, cria o usuário no banco e gera um token JWT para autenticação segura e acesso autorizado.
• Filtros de Produtos: Opções avançadas de filtro por categorias, espécies e preços, facilitando a busca.

🛠 Estrutura do Projeto

A API foi desenvolvida utilizando uma arquitetura modular, com módulos, controladores e serviços, proporcionando uma manutenção mais ágil e organizada. A comunicação com o banco de dados é gerenciada pelo Sequelize, enquanto o uso de tokens JWT e Firebase fortalece a autenticação e a segurança da aplicação.

⚙️ Configuração e Uso

1. Clone o repositório e navegue até o diretório do projeto:

git clone https://github.com/TypeBlast/projectApi
cd projectApi

2. Instale as dependências:
   npm install

3. Configure as variáveis de ambiente (exemplo no arquivo .env.example).

4. Execute as migrações do banco de dados:
   npx sequelize db:migrate

5. Inicie o servidor:
   npm start

🚨 Notas Importantes

• Configuração de Variáveis de Ambiente: Verifique o .env para incluir as credenciais de banco de dados
• Esta versão inclui autenticação JWT para endpoints sensíveis, e o limite de até 15 pets e 3 endereços por usuário foi adicionado.

📖 Documentação

Acesse a Documentação Oficial para detalhes dos endpoints, formatos de requisição e resposta, e outras instruções..

🔄 Próximos Passos

• Integração com gateways de pagamento reais.
• Notificações por e-mail para confirmação de pedidos.
• Expansão para dashboards e relatórios gerenciais.

Agradecemos por utilizar a API de Petshop! Para dúvidas ou sugestões, abra uma issue no repositório.

PetExpress API v1.0.0

Estamos empolgados em anunciar a primeira versão estável da API de Petshop! Esta versão inclui todos os recursos essenciais para gerenciar usuários no sistema, permitindo o cadastro, listagem, edição, exclusão e autenticação de usuários. A API foi desenvolvida em Node.js utilizando Sequelize, seguindo uma estrutura modular inspirada no NestJS, o que facilita a manutenção e a escalabilidade do código.

🚀 Novidades

• Cadastro de Usuários: Agora você pode cadastrar novos usuários fornecendo nome, e-mail, senha, telefone e CPF.
• Listagem de Usuários: Consulte a lista completa de usuários cadastrados no sistema.
• Edição de Usuário: Edite as informações de um usuário específico utilizando seu ID.
• Consulta por ID: Obtenha detalhes de um usuário específico através do seu ID.
• Exclusão de Usuário: Remova um usuário do sistema utilizando seu ID.
• Autenticação: Autentique-se na aplicação utilizando e-mail e senha.

🛠 Estrutura do Projeto

Esta versão da API foi construída utilizando uma estrutura modular semelhante ao NestJS, organizada em módulos, controladores e serviços, o que facilita a manutenção e o desenvolvimento de novas funcionalidades. O Sequelize foi utilizado como ORM para gerenciar a comunicação com o banco de dados, permitindo que as operações de CRUD sejam realizadas de maneira eficiente.

📦 Como Utilizar

1. Clone o repositório e navegue até o diretório do projeto:

git clone https://github.com/TypeBlast/projectApi
cd projectApi

2. Instale as dependências:
   npm install

3. Configure as variáveis de ambiente (exemplo no arquivo .env.example).

4. Execute as migrações do banco de dados:
   npx sequelize db:migrate

5. Inicie o servidor:
   npm start

🚨 Notas Importantes

• Certifique-se de configurar corretamente o arquivo .env com as credenciais do seu banco de dados.
• Esta versão é considerada estável para uso em produção, mas recomendamos a realização de testes antes de implementar em ambientes críticos.

📖 Documentação

Para informações detalhadas sobre o uso da API, incluindo exemplos de requisições, parâmetros e respostas, acesse a Documentação Oficial.

🔄 Próximos Passos

• Implementação de autenticação JWT para proteger os endpoints.
• Adição de testes automatizados para garantir a qualidade do código.
• Expansão do sistema para incluir o gerenciamento de pets, agendamentos e serviços.

Agradecemos por usar a API de Petshop! Caso tenha alguma dúvida ou sugestão, fique à vontade para abrir uma issue no repositório.