https://github.com/bjverde/cnpjrfb
:elephant: Sistema para Consultar os dados públicos do CNPJ disponibilizados pela Receita Federal em PHP usando Adianti 7.1 e CNPJ-full
https://github.com/bjverde/cnpjrfb
adianti adianti-framework cnpj php php7 php73
Last synced: 11 months ago
JSON representation
:elephant: Sistema para Consultar os dados públicos do CNPJ disponibilizados pela Receita Federal em PHP usando Adianti 7.1 e CNPJ-full
- Host: GitHub
- URL: https://github.com/bjverde/cnpjrfb
- Owner: bjverde
- Created: 2020-01-18T17:23:53.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-02T14:42:36.000Z (over 1 year ago)
- Last Synced: 2025-02-25T04:01:37.757Z (11 months ago)
- Topics: adianti, adianti-framework, cnpj, php, php7, php73
- Language: PHP
- Homepage:
- Size: 25.6 MB
- Stars: 60
- Watchers: 10
- Forks: 21
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cnpjrfb
Sistema web em PHP usando o usando o [Adianti FrameWork](https://www.adianti.com.br/framework) para consultar os [Dados públicos CNPJ](https://dados.gov.br/dados/conjuntos-dados/cadastro-nacional-da-pessoa-juridica---cnpj) fornecidos pela Receita Federal do Brasil.
A Versão 2.0.0 contem as alterações do modelo de dados de 21/03/2021 feito pela RFB.
Agradecimento para todas as pessoas que contribuíram de forma direta ou indireta para o projeto. Abaixo alguns nomes de destaque, pois o sistema de consulta foi baseado nos scripts de carga de dados das pessoas abaixo. Sem essas pessoas o trabalho seria bem mais difícil:
* Versão 2.0.0 ou superior, Aphonso Henrique do Amaral Rafael - https://github.com/aphonsoar/Receita_Federal_do_Brasil_-_Dados_Publicos_CNPJ
* Até a versão 1.2.0, Fabio Serpa - https://github.com/fabioserpa/CNPJ-full
# Instalando e rodando
O processo de instalação é simples para a parte PHP. Porém a carga do banco de dados pode ser complicada e muito demorada, levando algumas horas até dias dependendo do seu hardware.
## Requisitos
* Apache PHP 8.1 ou superior para a versão 2.1.0 ou superior.
* Banco de Dados Relacional, com a carga dos dados conforme modelo. Funciona nos bancos PostgreSQL, MySQL, MariaDB, SQLite !
* Aproximadamente 50 GB de espaço livre em disco para a instalação:
* 6,1 GB arquivos zip da Receita Federal (Agosto/2024), que pode ser liberado depois da instalação.
* 18 GB para arquivos texto descompactados, que pode ser liberado depois da instalação
* 18 GB para banco de dados. Considerando o PostgreSQL.
## Informação sobre o Banco de dados e carga ETL
Tabela | Quantidade de linhas | Tamanho em MB
------ | ------------------ | --------------------
empresa | 45.811.638 |
estabelecimento | 48.421.619 |
socios | 20.426.417 |
simples | 27.893.923 |
**Total** | **142.553.597**|
## Intalação separada
### Parte 1 - PHP
1. Ter um servidor PHP 8.1 ou superior. Com o drive PDO do banco relacional desejado e para o SqLite
1. Configura o PHP conforme orientações do [Adianti FrameWork 7.3.0](https://www.adianti.com.br/framework-quickstart)
1. Crie no seu servidor a pasta `cnjrfb`.
1. Copie o conteudo da pasta `www/cnjrfb` do projeto para a pasta `cnjrfb` do seu servidor PHP.
1. Verifique se tudo dentro de `/cnjrfb/` tem permissão de execução do servidor web. Se for Linux (Debian/Ubuntu) com Apache pode executar `sudo chown -R www-data:www-data`
1. Abra o sistema em um navegador e verifique se os sistema está funcionando. Existe um pequeno banco em SqLite para demonstrar o funcionamento.
**ATENÇÃO!! a função de gerar grafo foi removida temporarimente da versão 2.**
### Parte 2 - a carga dos dados, no banco relacional !
Agora vem parte demorada !
### Caminho normal
* Baixe todos os arquivos do [site de receita federal](https://dados.gov.br/dados/conjuntos-dados/cadastro-nacional-da-pessoa-juridica---cnpj). Para quem está usando Linux tem um script para essa parta `www/cargabs/download/download_files.sh`
* Script PHP para carga no banco
* na pasta `projeto/modelo_banco/` vai encontrar os scripts criação do banco de dados, para os SGBD's: SqLite, MySql, MariaDB e PostgreSQL. Se precisar de um MER tem na pasta `projeto/modelo_banco/mysql`
* Altere o arquivo de configuração `projeto/www/cargabd/config.php`
* rode o script em modo terminal `projeto/www/cargabd/index.php`
* vá descençar !! o processo todo em desktop no win10, i5, 16 ram, PHP 7.4 no wamp com config padrão levou mais de 30 horas.
### Caminho alternativo
* Se conhece python e deseja usar o PostgreSQL faça os procedimentos https://github.com/aphonsoar/Receita_Federal_do_Brasil_-_Dados_Publicos_CNPJ
**ATENÇÃO!! devido o volume de dados crie índices, nas colunas que pretender ter o maior volume de pesquisa e assim diminuir o tempo de busco. Recomendo criar na coluna cnpj_basico em todas as tabelas**
### Parte 3 - Configurando o PHP para o banco completo !
* altera o arquivo `/cnjrfb/app/config/maindatabase.php` para apontar para o novo banco de dados. Veja como em [Adianti FrameWork 7.3.0](https://www.adianti.com.br/framework-quickstart)
* PARA quem criu o banco o DATABASE_SCHEMA altere o arquivo `/cnjrfb/init.php` na linha 33 alterando o valor da constante `define('DATABASE_SCHEMA','');` para o valor desjado usando o PONTO para separar SCHEMA.TABELA
## Intalação via Docker-compose - NÃO ESTÁ COMPLETO
Existem alguns arquivos em Docker-compose para criar todo o ambiente necessários para rodar tudo que é necessário. A ideia é com um comando o usuário consiga ter tudo funcionando sem muito esforço.
1. Instale o Docker e Docker-compose
1. Abriu um terminal na raiz do projeto
1. Execute o comando `docker-compose build` para gerar todo o ambiente.
1. Execute o comando `docker-compose -f docker-compose.yml up -d` para rodar o ambiente já configurado. O Docker pretender resolver apenas [Parte 1 - PHP](#parte-1---php)
1. Verificando se a instalação está correta: Abra o sistema em um navegador e verifique se os 3 menus dentre home está funcionando: Empresa, Sócios e CNEA.