💻 Site   |   📚 Stories   |   🤖 Coverage  

Star Wars Explorer

Sobre   |   Tecnologias   |   Pré requisitos   |   Começando   |   Licença   |   Autor

🎯 Sobre

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

🚀 Principais tecnologias

                               

 

Ver mais

• Styled Media Query
• Styled Icons
• React Lottie
• Axios
• Plop

✅ Pré requisitos

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

🏁 Começando

# 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>

🎮 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
• cy:open: roda a interface do cypress
• cy:run: roda o cypress pela cli
• test:e2e: roda yarn dev + cy:open
• test:e2e:cli: roda yarn dev + cy:run
• storybook: inicia o storybook em localhost:6006
• build-storybook: cria a build do storybook
• generate: 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.  

📝 Licença

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

Feito com ❤️ por Mauro de Souza

 

Voltar para o topo

Readme criado com Simple Readme