felipeandrade04/marvel-comics-app

Aplicação Web para explorar informações de quadrinhos da API da Marvel

Marvel Comics

Indice

• Sobre
• Funcionalidades
• Próximos passos
• Tecnologias
• Como baixar e executar o projeto

---

🔖 Sobre

O Marvel Comics é uma aplicação web desenvolvida com o intuito de consumir e explorar informações dos quadrinhos da API da Marvel.

---

🚀 Funcionalidades

• Layout responsivo
• Listar quadrinhos da API
• Paginação das informações
• Modal de detalhes do quadrinho ao clica sobre ele
• Filtro de busca para pesquisar quadrinhos pelo título
  • Para o filtro foi desenvolvido um hook de debounce para melhorar a performance
• Selecionar quadrinhos para envio
  • Modal que lista os quadrinhos selecionados e disponibiiliza um mapa para selecionar o local de envio
• Exibir os repositórios do perfil no Github
• Padronização de código utilizando ESlint e Prettier
• Padronização de commits utilizando Husky e Commitlint

---

🎯 Próximos passos

• Desenvilvimento de uma suíte de testes
• Listagem das demais informações da API

---

👩🏻‍💻 Tecnologias

O projeto foi desenvolvido utilizando as seguintes tecnologias:

• ReactJS
• Typescript
• Styled-components
• Axios
• Husky
• Commitlint
• API da Marvel
• API do Google Maps
• VS Code with ESLint and Prettier

---

🗂 Como baixar e executar o projeto

Para clonar e executar esta aplicação na sua máquina é necessário ter instalado:

• Git
• Yarn
• Node.js

Para configurar a aplicação também é preciso ter:

• Chave pública e privada da API da Marvel
• Chave da API do Google Maps

  # Clonar o repositório
  $ git clone https://github.com/felipeAndrade04/marvel-comics-app.git

  # Entrar no diretório
  $ cd marvel-comics-app

  # Instalar as dependências
  $ yarn install

  # Duplicar o arquivo .env.example, renomear para .env e substituir as informações de acesso no seu devido local.

  # Iniciar o projeto
  $ yarn start

Desenvolvido por Felipe Andrade