marvel-explorer

 

:dart: Sobre

O Marvel Explorer é um projeto que foi desenvolvido para o desafio front end da FPass!

O desafio consiste em criar um pequeno app utilizando a API da Marvel para que no mínimo pesquise/liste os heróis pelo nome.

Para fazer o app utilizei o Nextjs para criar toda a interface, Storybook para fazer a documentação dos componentes, e para os teste, Jest com Testing Library, e tudo isso com Typescript ❤

:rocket: Principais tecnologias

 

• Styled Media Query
• Styled Icons
• Axios
• Plop

:white_check_mark: Pré requisitos

Antes de começar :checkered_flag:, você precisa ter o Git e o Node instalados em sua maquina.

Também vai precisar ter uma conta de desenvolvedor na Marvel para poder obter a sua chave da API.

:checkered_flag: Começando

# Clone este repositório
$ git clone https://github.com/maurodesouza/marvel-explorer

# Entre na pasta
$ cd marvel-explorer

# Crie um arquivo .env.local e preencha as seguintes variavéis

MARVEL_API_URL=https://gateway.marvel.com:443/v1/public
MARVEL_API_KEY=

## https://developer.marvel.com/documentation/authorization - Authentication for Server-Side Applications
MARVEL_HASH=
MARVEL_TS=

## Você pode seguir o arquivo .env.example também se preferir!

# Instale as dependências
$ yarn

# Para iniciar o projeto
$ yarn dev

# O app vai inicializar em <http://localhost:3000>

:video_game: Comandos

• dev: inicia a aplicação em localhost:3000
• build: cria a build para produção
• start: inicia um server com o código da build
• lint: roda o eslint na pasta src
• test: roda os testes
• test:watch: roda os testes no watch mode
• storybook: inicia o storybook em localhost:6006
• build-storybook: cria a build do storybook
• generate: cria a estrutura padrão de um componente

 

:memo: Licença

Este projeto está sob licença MIT. Veja o arquivo LICENSE para mais detalhes.

Feito com :heart: por Mauro de Souza

 

Voltar para o topo