Skip to content

joselisboaa/StoreMapping

Repository files navigation

Client System

Repositório do Projeto do frontend de TJW

Sobre

O sistema proposto a ser desenvolvido se trata de um sistema interno de uma empresa de gerenciamento de lojas, onde seriam registrado as lojas, clientes, entradas, cidades das lojas, tudo isso seria registrado e gerenciado e as lojas poderiam ser vistas em um mapa, facilitando a visualização e gerenciamento das lojas.

Instalação

Primeiramente utilize o comando

git clone https://github.com/joselisboaa/StoreMapping.git

para poder clonar o projeto localmente

Principais Bibliotecas/Ferramentas

Environment Info
Node v.20.3.2
React v.18.2.14
Next.js 13.4.7
React Hook Form v.7.45.1
Zod v.3.21.4
TypeScript v.5.1.5
Tailwindcss v.3.3.2
Recharts v.2.7.2
React Query v.4.29.1
classNames v.2.3.2
tailwind-merge v.1.13.2
tailwind-scrollbar v.3.0.4
json-server v.0.17.3
react-toastify v.9.1.2
@react-google-maps/api v.2.18.1

Documentação

React
React Hook Form
TypeScript
Next.js
Zod
Tailwind
React notifications component
Recharts
React Query

Instalação para desenvolvimento

Com todos os pré-requisitos instalados. Após clonar o projeto execute o comando:

npm install

Depois de iniciar a pasta node_modules, execute o comando:

npm run dev

Isso irá iniciar o servidor front-end

OBS: A maneira de instalar npm e node varia com o sistema operacional. Geralmente é utilizado o nvm.

Url para acessar o servidor:

http://localhost:3000/

Padrões

Padrão de id

O id deve ser AG junto com a id da issue com 3 casas de unidades, exemplo: SM001

Padrão de issue

  • feature/{id} - {Titulo}
  • bugfix/{id} - {Titulo}
  • refactor/{id} - {Titulo}
  • architecture/{id} - {Titulo}
  • document/{id} - {Titulo}

Obs: Os titulos devem ser em inglẽs.

Padrão de branch

  • feature/{id}
  • bugfix/{id}
  • refactor/{id}

Padrão de commit

O projeto utiliza os padrões do Conventional commmits