andersonmalheiro / gh-finder

Github Finder

Encontre usuários do Github.

Descrição

Projeto criado utilizando:

• React JS;
• Styled components;
• ESLint + Prettier + Styleguide Airbnb;
• React Leaflet + Mapbox;
• Redux Toolkit;
• Testes com Jest;
• Docker;
• SemaphoreCI -

Instruções

Instruções de como executar o projeto:

Instale as dependências:

npm install
# ou
yarn

Antes de executar o projeto, crie na raiz dele um arquivo .env.local e adicione as seguintes variáveis de ambiente:

REACT_APP_GITHUB_KEY=<chave do Github>
REACT_APP_MAPS_KEY=<chave do Mapbox>

Para o mapa foi utilizado o Mapbox. Então para testar localmente será necessário criar uma conta nele e obter a chave necessária para preencher o arquivo .env.local

---

Para executar o projeto em modo de desenvolvimento, execute o seguinte comando:

npm start
# ou
yarn start

O projeto será ficará disponível no endereço http://localhost:3000.

Para executar uma build de produção, utilize os seguintes comandos:

npm run build
# ou
yarn build

Testes

Para executar os testes unitários, utilize os seguintes comandos:

npm run test
# ou
yarn test

Testes E2E / Docker

Os testes E2E foram implementados utilizando Cypress. Para isso foi feita uma imagem docker específica para a execução dos mesmos. Com isso, para executá-los é necessário ter o projeto rodando com docker, com os seguintes comandos:

## Este comando executa a imagem do front, que ficará disponível em http://localhost:8080

docker-compose up frontend

Em seguida utilize o seguinte comando para executar os testes:

## Este comando executa a imagem de testes

docker-compose up e2e