Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/avrcoelho/react-search-geolocation
https://github.com/avrcoelho/react-search-geolocation
Last synced: 17 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/avrcoelho/react-search-geolocation
- Owner: avrcoelho
- Created: 2020-02-22T18:35:34.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-02-27T00:43:21.000Z (almost 5 years ago)
- Last Synced: 2024-11-08T04:39:48.965Z (2 months ago)
- Language: TypeScript
- Size: 473 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Busca de Endereço
> Aplicação para busca de endereço pelo CEP, utilizando as API`s [ViaCEP](https://viacep.com.br/) e [Google Map](https://maps.googleapis.com/) para exibir a localização no Mapa.
## Demonstação
A aplicação está hospedada no [netlify](https://www.netlify.com/). Acesse o link [https://unruffled-hermann-6fc551.netlify.com/](https://unruffled-hermann-6fc551.netlify.com/) para executa-la.
## Instalação
_Tenha instalado em sua maquina o [Git](http://git-scm.com/) e [Node.js](http://nodejs.org/) 10.0.0 (ou superior). Caso prefira, instale o [Yarn](https://yarnpkg.com/)._
1. Fork este repositório e crie um novo branch — ou crie um novo branch caso tenha permissão.
2. Depois de obter sua cópia local, instale suas dependências:
```sh
npm install
```
ou
```sh
yarn
```
4) Crie um arquivo `.env` no diretório raiz, com as sequintes variaveis:
```sh
REACT_APP_URL_API_VIACEP=https://viacep.com.br/ws
REACT_APP_URL_API_MAPS=https://maps.googleapis.com/maps/api
REACT_APP_TOKEN_MAPS=
REACT_APP_TOKEN_MAPGL=
```
## Execução
Após a instalação, você podera executar a aplicação em modo de desenvolvimento:
```sh
npm start
```
ou
```sh
yarn start
```
_Isso iniciará o servidor em `localhost:3000`_
## Build
Execute:
```sh
npm run build
```
ou
```sh
yarn build
```
_Isso irá criar um diretório `build` na raiz, com a aplicacão preparada para ser executada em producão._
## Testes
_Todos os arquivos de testes terminam com `.spec.tsx`_
Use o seguinte comando para executar os testes:
```sh
npm test
```
ou
```sh
yarn test
```
_Caso deseja gerar os aquivos de Coverage, execute:_
```sh
npm run coverage
```
ou
```sh
yarn coverage
```
_Isso irá criar um diretório `__tests__` dentro do diretório `src` com os arquivos de Coverage_
## Licença
[MIT](https://opensource.org/licenses/MIT)