Skip to content

SPURB/mapa-consulta-arco-pinheiros

Repository files navigation

PIU Arco Pinheiros

Mapa interativo da consulta pública do Projeto de Intervenção Urbana Arco Pinheiros.

Pré-requisitos para desenvolvimento.

São necessárias as seguintes instalações globais para iniciar o desenvolvimento:

Setup para desenvolvimento

  1. Clone o repositório e instale as dependências do projeto.
# clone este repositório
git clone https://github.com/SPURB/mapa-consulta-arco-pinheiros.git

cd mapa-consulta-arco-pinheiros

# instale as dependências deste projeto
npm i
  1. Em uma nova janela do terminal inicie a aplicação para desenvolvimento em http://localhost:1234.
npm run start

A aplicação deve estar funcionando em localhost:1234 no seu browser.

Variáveis de ambiente

Configure as variáveis de ambiente. A partir do arquivo .env crie dois arquivos .env.development.local e .env.production.local. As variáveis serão trocadas de acordo com a tabela abaixo:

Comandos Variáveis
npm run start .env.development.local
npm run build .env.production.local

As variáveis a serem configuraddas nos arquivo *.env são:

BING_API_KEY=some-token
APP_URL=https://participe.gestaourbana.prefeitura.sp.gov.br/mapas/piu-arco-pinheiros-2/
API_TOKEN=some-token
API_URL=https://api.gestaourbana.prefeitura.sp.gov.br/

Arquivos no padrão env.*.local são ingnorados pelo git. Cuidado para não comitar estas variáveis em outros arquivos. Não comitar deleção ou alterações no arquivo .env.

Crie uma chave no bing maps e atualize o valor de BING_API_KEY para visualizar a base do mapa localmente.

Compile os arquivos para publicação

  1. Crie um arquivo .env.production.local com os mesmos parâmetros do arquivo .env atualizando os valores do seu ambiente da publicação.

  2. Compile os arquivos no diretório dist/

npm run build

Publique os arquivos criados em dist/ para endereço especificado em .env.production.local.

Atualização de dados

Os dados da aplicação (data-src/json/*.json) são arquivos compilados da planilha do google docs. Havendo atualizações nesta planilha será necessário compilar novamente. Para fazer isso rodar o comando abaixo antes de npm run start ou build:

npm run files

Documentação de bugs

Toda contribuição é bem vinda. Crie uma issue.

Licença

GNU General Public License v3.0.