Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/riquellopes/fii

API para recuperar informações sobre FII
https://github.com/riquellopes/fii

crawler investiment mongodb nodejs

Last synced: about 2 months ago
JSON representation

API para recuperar informações sobre FII

Awesome Lists containing this project

README

        

[![Build Status](https://travis-ci.org/riquellopes/fii.svg)](https://travis-ci.org/riquellopes/fii)

# API fundo de investimento imobiliário - FII.
Para você que curte o mercado financeiro, em especial [FII](http://www.bmfbovespa.com.br/Fundos-Listados/FundosListados.aspx?tipoFundo=imobiliario&idioma=pt-br) e tem uma enorme dificuldade para saber quanto vai receber de proventos. Resolvi juntar o útil ao agradável, estudar um pouco mais sobre [Nodejs](https://nodejs.org) e procurar bons sites com conteúdo gratuíto sobre [FII](http://www.bmfbovespa.com.br/Fundos-Listados/FundosListados.aspx?tipoFundo=imobiliario&idioma=pt-br). Acabei criando uma api muitos simples, que recupera o valor de todos os proventos que vão ser pagos.

### Como funciona?
Existe um [Makefile](https://en.wikipedia.org/wiki/Makefile) com comandos básicos ainda, **_make run_** e **_make test_**. Você precisa ter o [Nodejs](https://nodejs.org) instalado na sua máquina. Após clonar o projeto basta executar os comando abaixo:
```shell
npm install
make test
make run
```
### Observações:
O app está rodando na porta 5000. Eu estou usando o [dotenv](https://www.npmjs.com/package/dotenv) nesse projeto, então antes de você começar a executar, você precisa criar 2 arquivos que estão no .gitignore o .env e o .env.test, eles vão possuir as informações que devem ser utilizadas para que o [mogoose](http://mongoosejs.com) se connecte ao [mongodb](https://www.mongodb.org) da sua máquina, e a url do site que você vai [crawlear](https://pt.wikipedia.org/wiki/Web_crawler), que nesse projeto é o http://fiis.com.br/resumo.

### Dica:
Se você não tem [mongodb](https://www.mongodb.org) na sua máquina, ou não quer perder tempo instalando, existe um serviço free é muito legal, o [mongolab](https://mongolab.com).