Bem-vindo à documentação do Projeto Dashboard. Este documento fornece informações importantes sobre como instalar, configurar e utilizar o projeto.
Para instalar o projeto, siga estas etapas:
-
Certifique-se de ter o Node.js e o npm instalados em seu sistema. Você pode baixá-los em nodejs.org.
-
Clone este repositório em sua máquina local usando o seguinte comando:
git clone https://github.com/GabrielGirardi/dashboard.git
- Navegue até o diretório do projeto:
cd dashboard
- Navegue até o frontend:
cd project
- instale as dependências do projeto com o seguinte comando:
npm install
- Retorne ao diretório principal do projeto:
cd ..
- Navegue até o backend:
cd backend
- Novamente execute o comando para baixar as dependências:
npm install
##Configuração do Banco de Dados
O acesso ao banco de dados é liberado por IP. No entanto, o acesso está disponível apenas até o dia 9 de Marçp de 2024. Caso queira acesso após a expiração, entre em contato comigo!
Após a instalação e configuração, você pode iniciar o servidor local executando o seguinte comando:
cd backend
npm start
Isso iniciará o servidor e tornará o projeto backend disponível no endereço http://localhost:3000, lembre-se que exite as rotas para as coleções, como link/api/customers.
Para iniciar o frontend, abra outro terminal e execute o seguinte comando:
cd project
npm run dev
Isso iniciará o frontend e tornará o projeto disponível no endereço http://localhost:5173
##Futuras Melhorias
Estarei buscando maneiras de melhorar nosso projeto e proporcionar uma experiência ainda melhor aos usuários. Abaixo estão algumas melhorias planejadas que pretendo implementar no futuro:
- Refatoração do Código
Estou comprometido em refatorar nosso código existente para torná-lo mais limpo, organizado e fácil de manter. Isso inclui a identificação de partes do código que podem ser simplificadas, divididas em funções menores ou otimizadas para melhorar a legibilidade e a manutenção do código.
- Validações Avançadas
Planejo implementar validações mais complexas nos dados de entrada, como validação de formato de e-mail, tela de login, entre outras. Isso garantirá a integridade dos dados e uma melhor experiência para o usuário.
- Melhorias na Experiência do Usuário (UX)
Estou trabalhando para aprimorar nossa interface do usuário com animações suaves, feedbacks visuais claros e um design responsivo que funcione bem em dispositivos móveis. Além disso, pretendo adicionar funcionalidades de pesquisa, filtros e ordenação para facilitar a navegação e a localização de informações dentro do aplicativo.
Estou empolgado com essas melhorias e ansioso para compartilhar os resultados com vocês. Fiquem atentos às futuras atualizações do projeto!