explore sa node

	mestre	Heroku
testes
cobertura

'Explore Me SA GraphQQL' [Applicaion Server]

Este projeto está centrado na análise de vários conjuntos de dados, incluindo dados do governo do Reino Unido sobre vendas de propriedades, dados de relatórios policiais e dados de código postal. O objetivo é aproveitar as informações geográficas para estabelecer conexões entre códigos postais usando latitude e longitude.

O objetivo principal é desenvolver um back -end de graphQL escalável capaz de fornecer os resultados solicitados rapidamente. Esse empreendimento procura iluminar aspectos complexos do uso do GraphQL, abordando desafios como o problema N+1 e os cenários de escala em que mais de um banco de dados é necessário para nós de gravar e ler.

Os principais recursos do projeto incluem um sistema robusto de garantia de qualidade automatizada (controle de qualidade), incorporando a semeadura de dados anônimos para testes abrangentes de controle de qualidade. O projeto também explora a flexibilidade do JavaScript, ultrapassando os limites do idioma. Notavelmente, ele investiga as restrições dos campos de objeto V8 padrão, que são limitados em cerca de ~ 8,4 milhões, destacando a capacidade de manuseio superior da estrutura de dados do mapa.

Além disso, o projeto incorpora um sistema de filas para melhorar a eficiência do processamento de dados. Em essência, o projeto serve como uma demonstração prática de aspectos diversos e avançados do desenvolvimento de software, refletindo um compromisso com a excelência e a inovação.

• Demoção Live GraphQL [atualmente indisponível]
• Exemplo de aplicativo da web de como os dados podem ser consumidos
  • Aplicativo da web demonstração ao vivo [atualmente indisponível]

Requisitos de software

Se você estiver usando comandos make , o Docker e o Docker-Compose são necessários, e o Node.js local com NPM são opcionais

• Node.js v18+
• npm v5+ ou fio
• O opcional makefile sai da caixa em ambientes unixes
• Docker opcional v18.09+
• SQLITE OPCIONAL3 V3+ apenas para testes de 'integração'

tecnologias usadas

• Servidor Apollo
• Express.js
• Sequlize
• Dataloader
• GraphQL
• Jove

Serviços usados

• CIRCLE CI
• codecov
• Código clima
• Snyk

onde obter conjuntos de dados

• Codos postais do Reino Unido
• Dados de vendas da casa do Reino Unido
• Dados do LSOA e Código Post do Reino Unido
• Dados dos registros policiais

como instalar

• com comandos make não são necessários etapas adicionais, caso contrário você precisa executar $ npm i

Como executar testes

• $ make test ou $ npm test
  • Opcional 'jest' cli params, exemplos:
    • Para coletar cobertura, Exemplo: $ npm test -- --coverage , o relatório estará localizado em ./cobertura Diretório
    • Para executar testes apenas em um arquivo específico, por exemplo: $ npm test src/graphql/user.test.js

Como configurar um banco de dados

• A configuração do banco de dados está localizada no arquivo src/orm-config.js
• Para obter o esquema de banco de dados atualizado: $ npm run sql db:migrate , você também pode criar um banco de dados via ORM npm run sql db:create
• Para semear o banco de dados com dados 'Teste': $ npm run sql db:seed:all

Como executar no modo de 'desenvolvimento'

• $ make ou $ npm start

Como executar no modo de 'produção'

• $ make serve , não há equivalente a NPM
• Se você só precisar gerar ativos estáticos
  • $ make build ou $ npm run build - Os ativos gerados estarão localizados em ./build Directory

Como executar contêineres com diferentes variáveis ​​usando 'Make'

• make PORT=18081

GitFlow

• Heroku -> Produção atual, contém alterações específicas da produção , gatilho de esgotamento da produção em cada empurrão
• Mestre -> A maior parte da produção está pronta , todas as solicitações de puxar nesta filial obtiveram verificação obrigatória 'CI/Circleci: Jest'
• Filiais de recurso -> Fique fundido no ramo mestre quando estiverem prontos e cheques obrigatórios passados
• CI executa testes em um ambiente isolado

Variáveis ​​de ambiente usadas

Variável	Valor padrão	Tipo	Descrição
PORTA	8081	número	A porta na qual o aplicativo estará disponível.
Ssl_key		corda	O caminho absoluto para a chave SSL (por exemplo, /home/ubuntu/private.key ).
SSL_CERT		corda	O caminho absoluto para o certificado SSL (por exemplo, /home/ubuntu/certificate.crt ).
***	***	***	Se a configuração de uma réplica for especificada, as conexões não replicações serão usadas apenas para gravações.
Db_hostname	127.0.0.1	corda	O host no qual o banco de dados pode ser alcançado.
Db_username	raiz	corda	O nome de usuário para se conectar ao banco de dados.
Db_password	senha	corda	A senha do usuário do banco de dados.
Db_port	3306	número	A porta na qual o banco de dados pode ser alcançado.
Db_name	explorar	corda	O nome do esquema do banco de dados.
Db_dialect	mysql	corda	O dialeto do banco de dados, um dos mysql / sqlite / postgres.
Db_replica_hostname	127.0.0.1	corda	O host da réplica do banco de dados para operações somente leitura.
Db_replica_username	raiz	corda	O nome de usuário para se conectar à réplica do banco de dados para operações somente leitura.
Db_replica_password	senha	corda	A senha para o usuário que se conecta à réplica do banco de dados para operações somente leitura.

processadores de dados

Comando npm	arquivo JS correspondente
parse:postcodes	src/parse:postcodes
parse:postcodes:lsoa	src/parse:postcodes:lsoa
parse:incidents	src/parse:markers:and:incidents
parse:properties	src/parse:markers:and:properties
parse:areas	src/parse:areas
parse:timelines	src/parse:timelines

Exemplo: npm run parse:postcodes -- --file=/media/data/postcodes.csv

bancos de dados suportados

banco de dados	versão	adaptador	PRINCIPAL PRINCIPAL
Mysql	8	mysql2	produção
PostGresql	11	pág	produção
Sqlite	4	SQLITE3	Automação de QA e CI

• Se você usar o MySQL 5.7+, precisará garantir que ele possa funcionar com a senha nativa do MySQL

• Postrgesql e sqlite são parcialmente suportados porque algumas das consultas não são totalmente agnósticas do motor, e algumas funções não existem no sqlite, por exemplo,