Sobre | Tecnologias | Pré requisitos | Começando | Licença | Autor
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 ❤
Antes de começar 🏁, 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.
# 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>
dev
: inicia a aplicação emlocalhost:3000
build
: cria a build para produçãostart
: inicia um server com o código da buildlint
: roda o eslint na pasta srctest
: roda os testestest:watch
: roda os testes no watch modestorybook
: inicia o storybook emlocalhost:6006
build-storybook
: cria a build do storybookgenerate
: cria a estrutura padrão de um componente
Este projeto está sob licença MIT. Veja o arquivo LICENSE para mais detalhes.
Feito com ❤️ por Mauro de Souza