explore sa node

	maestro	Heroku
pruebas
cobertura

'Explore Me Sa GraphQQL' [Server ApplicAion]

Este proyecto se centra en la analización de varios conjuntos de datos, incluidos los datos del gobierno del Reino Unido sobre las ventas de propiedades, los datos de informes policiales y los datos del código postal. El objetivo es aprovechar la información geográfica para establecer conexiones entre los códigos postales utilizando latitud y longitud.

El objetivo principal es desarrollar un backend GraphQL escalable capaz de entregar rápidamente los resultados solicitados. Este esfuerzo busca iluminar aspectos intrincados del uso de GraphQL, abordando desafíos como el problema N+1 y escenarios de escala en los que se requiere más de una base de datos para los nodos de escritura y lectura.

Las características clave del proyecto incluyen un sistema robusto de garantía de calidad automatizada (QA), que incorpora la siembra de datos anónimas para pruebas integrales de control de calidad. El proyecto también explora la flexibilidad de JavaScript, empujando los límites del idioma. En particular, profundiza en las restricciones de los campos de objetos V8 predeterminados, que están limitados a alrededor de ~ 8.4 millones, al tiempo que resalta la capacidad de manejo superior de la estructura de datos del mapa.

Además, el proyecto incorpora un sistema de cola para mejorar la eficiencia del procesamiento de datos. En esencia, el proyecto sirve como una demostración práctica de aspectos diversos y avanzados del desarrollo de software, lo que refleja un compromiso con la excelencia e innovación.

• Graphql Live Demo [actualmente no disponible]
• Ejemplo de aplicación web de cómo se pueden consumir datos
  • Aplicación web Demo en vivo [actualmente no disponible]

requisitos de software

Si está utilizando comandos make , Docker y Docker-Compose son necesarios, y Node.js locales con NPM son opcionales

• node.js v18+
• npm v5+ o hilo
• Makefile opcional sale de la caja en unix entornos
• Docker opcional V18.09+
• SQLite3 V3+ opcional para pruebas de 'integración' solamente

tecnologías utilizadas

• servidor Apollo
• Express.js
• parar
• dataloader
• gráfico
• broma

servicios usados

• CI CIRSE
• Codecov
• clima de código
• snyk

dónde obtener conjuntos de datos

• Códigos postales del Reino Unido
• Datos de ventas de la casa del Reino Unido
• Datos de LSOA y código postal del Reino Unido
• Datos de registros policiales

Cómo instalar

• con comandos make no se requieren pasos adicionales, de lo contrario, debe ejecutar $ npm i

Cómo ejecutar pruebas

• $ make test o $ npm test
  • parámetros de cli 'jest' opcionales , ejemplos:
    • Para recopilar cobertura, ejemplo: $ npm test -- --coverage , se ubicará en el directorio ./COVERAGE
    • Para ejecutar pruebas solo en un archivo específico, por ejemplo: $ npm test src/graphql/user.test.js

Cómo configurar una base de datos

• La configuración de la base de datos se encuentra en el archivo src/orm-config.js
• Para obtener el esquema de la base de datos actualizado: $ npm run sql db:migrate , también puede crear una base de datos a través de orm npm run sql db:create
• Para sembrar la base de datos con datos de 'prueba': $ npm run sql db:seed:all

Cómo ejecutar en modo 'Desarrollo'

• $ make o $ npm start

Cómo ejecutar en modo 'Producción'

• $ make serve , no hay equivalente de NPM
• Si solo necesita generar activos estáticos
  • $ make build o $ npm run build : los activos generados se ubicarán en el directorio ./Build

Cómo ejecutar contenedores con diferentes variables usando 'hacer'

• make PORT=18081

flow

• Heroku -> Producción actual, contiene cambios específicos de producción , desencadenar la producción deplomente en cada empuje
• Maestro -> La mayoría de la producción de la fecha hasta la fecha, todas las solicitudes de extracción de esta rama obtuvieron el cheque obligatorio 'CI/Circleci: Jest'
• Ramas de características -> Gégase en la rama maestra cuando estén listas y se pasan los cheques obligatorios
• CI ejecuta pruebas en un entorno aislado

Variables de entorno utilizadas

Variable	Valor predeterminado	Tipo	Descripción
PUERTO	8081	número	El puerto en el que estará disponible la aplicación.
Ssl_key		cadena	El camino absoluto a la tecla SSL (p. Ej., /home/ubuntu/private.key ).
Ssl_cert		cadena	La ruta absoluta al certificado SSL (por ejemplo, /home/ubuntu/certificate.crt ).
***	***	***	Si se especifica la configuración de una réplica, las conexiones no replicarias se usan solo para escrituras.
Db_hostname	127.0.0.1	cadena	El host en el que se puede llegar a la base de datos.
Db_username	raíz	cadena	El nombre de usuario para conectarse a la base de datos.
Db_password	contraseña	cadena	La contraseña para el usuario de la base de datos.
Db_port	3306	número	El puerto en el que se puede llegar a la base de datos.
Db_name	explorar	cadena	El nombre del esquema de la base de datos.
Db_dialect	mysql	cadena	El dialecto de la base de datos, uno de MySQL / SQLite / Postgres.
Db_replica_hostname	127.0.0.1	cadena	El host de la réplica de la base de datos para operaciones de solo lectura.
DB_REPLICA_USERNAME	raíz	cadena	El nombre de usuario para conectarse a la réplica de la base de datos para operaciones de solo lectura.
Db_replica_password	contraseña	cadena	La contraseña para el usuario que se conecta a la réplica de la base de datos para operaciones de solo lectura.

procesadores de datos

Comando npm	Archivo JS correspondiente
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

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

bases de datos compatibles

base de datos	versión	adaptador	propósito principal
Mysql	8	mysql2	producción
Postgresql	11	pg	producción
Sqlite	4	sqlite3	QA Automation & CI

• Si usa MySQL 5.7+, debe asegurarse de que pueda funcionar con la contraseña nativa de MySQL

• Postrgesql y SQLite son parcialmente compatibles porque algunas de las consultas no son completamente agnósticas del motor, y algunas funciones no existen en SQLite, por ejemplo,