Giter VIP home page Giter VIP logo

code-challenge-front's Introduction

Code Challenge Frontend

Instalação

Navegue até o diretório do projeto e execute os seguintes comandos:

Copie o arquivo .env.example para o .env:

$ cp .env.example .env

Crie o container do projeto:

$ docker-compose up

Ou use o comando Make

$ make start

Não é necessário alterar as configurações do arquivo .env.example para que o projeto rode em modo de desenvolvimento. O frontend pode ser acessado no endereço http://localhost:5173.

É necessário iniciar o projeto backend antes de iniciar o frontend.

Ferramentas Utilizadas no Projeto

Bibliotecas

Decisões de Arquitetura e Design

Opções de Design

image

Toda a aplicação está contida em apenas uma página. Nela é possível visualizar os novos registros, buscá-los e executar as operações de Short Link, Refresh, Edit e Delete;

image

O as ações são acessadas através do menu de 'três pontos' no lado direito superior de cada card de perfil. Cada card tem dois campos adicionais:

  • 'Sync Status': informa ao usuário qual é o status atual sincronização do perfil com os dados do Github
  • 'Last Update': informa qual foi a última data que o perfil sofreu uma atualização;

image

A criação e atualização dos perfis são feitos através de modais. Foi adotada essa modalidade pelo fato de existir apenas dois campos para alteração, o que se encaixa bem nesse tipo de modal.

Arquitetura

Este projeto utiliza extensivamente a biblioteca React Query para gerenciar os estados das requisições à API. Entre as facilidades oferecidas por essa biblioteca, destaca-se a gestão eficiente do estado cacheado, que contribui para a otimização do desempenho e a redução de chamadas desnecessárias à API.

Também foram adotadas boas práticas de gestão de estado utilizando parâmetros. Dessa forma, os parâmetros de filtros e o número de páginas são mantidos através de query params na URL.

Melhorias

  • Atualmente, a biblioteca React Query no projeto invalida o cache da lista principal sempre que uma mutação é bem-sucedida. Como resultado, o frontend precisa recarregar os dados da lista toda vez que essa ação ocorre. Uma solução mais eficiente seria atualizar o item diretamente no cache local em vez de invalidá-lo completamente.

  • É necessário refatorar alguns componentes para adotar o padrão de composição, com destaque para o componente ProfileCard.

code-challenge-front's People

Contributors

guepardo avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.