yubathom / api-geosampa

Protótipo de API de arquivos estáticos e dados do portal Geosampa

{ API GeoSampa }

Proposta

Fornece por uma API REST as urls dos arquivos publicados no portal do GeoSampa. Este site faz parte de proposta desenvolvida para a Hackatona do GeoSampa.

Apresentação

https://docs.google.com/presentation/d/1a09Jy-icNA-1f2Y5YP67j80a8nmu9MTS-gz5yvJFORs/edit#slide=id.g5c7470dbe9_1_38

Instruções para montar localmente a aplicação

1. Instalar dependências

npm i

Instruções para desenvolver

1. Altere os markdowns do diretório docs/e altere as cofigurações de navegação do template emdocs/.vuepress/config.js.

# Inicie o ambiente de desenvolvimento da documentação em localhost:8080
npm run docs:dev

# Altere/crie conteúdo editando os markdowns
/docs/*.md

# Altere as configurações do template editando o config.js
/docs/.vuepress/config.js

2. Publique documentação no diretório public/

npm run docs:build

Instruções para desenvolver a API

• Desenvolva a aplicação (requer instalação global de nodemon - npm i -g nodemon)

npm run dev

• Publique a documentação e inicie a aplicação completa em localhost:3000

npm run start