Sobre | Tecnologias | Pré requisitos | Começando | Licença | Autor
O Star Wars Explorer é um projeto que foi desenvolvido para o desafio front end da Mamboo!
O desafio consiste em criar um pequeno app utilizando a API do Star Wars para que seja possível, pesquisar por algum personagem, ver mais informações sobre ele, e poder salva-lo como favorito.
Para fazer o app utilizei o Nextjs para criar toda a interface, Storybook para fazer a documentação dos componentes, e para os teste unitários, Jest com Testing Library e os e2e, Cypress, e tudo isso com Typescript ❤
Cypress testando a pagina de explorer
cypress-explorer-page.mp4
Antes de começar 🏁, você precisa ter o Git e o Node instalados em sua maquina.
# Clone este repositório
$ git clone https://github.com/maurodesouza/star-wars-explorer
# Entre na pasta
$ cd star-wars-explorer
# Crie um arquivo .env.local e preencha as seguintes variavéis
NEXT_PUBLIC_LOCAL_STORAGE_KEY=@sw-explorer:
SWAPI_API_URL=https://swapi.dev/api
## 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:3000build: 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 modecy:open: roda a interface do cypresscy:run: roda o cypress pela clitest:e2e: roda yarn dev + cy:opentest:e2e:cli: roda yarn dev + cy:runstorybook: inicia o storybook emlocalhost:6006build-storybook: cria a build do storybookgenerate: cria a estrutura padrão de um componente
OBS: Antes de rodar algum comando do cypress, verifique se você possui os pré requisitos necessários.
Este projeto está sob licença MIT. Veja o arquivo LICENSE para mais detalhes.
Feito com ❤️ por Mauro de Souza
Readme criado com Simple Readme