Skip to content

pcorbel/metaquery

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

metaquery

An API to analyze BigQuery metadata

License GoDoc

screenshot_project The WebUI


How to setup

docker-compose --file deployments/docker-compose.yaml up

Then go to localhost:8080


How to edit settings

They are three files to add your own configuration to the project:


Project Architecture

Backend

Description

The backend is based on Golang to:

  • Scrap data from API and BigQuery
  • Compute stats locally based on scraped data
  • The echo library to serve as API endpoint and to serve the frontend website

Dependencies Management

To manage dependencies, we use go modules

To update dependencies, execute: go get -u && go mod tidy

How to run development mode

To run development mode backend, execute: go run *.go

How to lint your code

To lint your code, execute: go fmt ./...

How to build

To build backend, execute: go build


Frontend

Description

The frontend is based on:

Dependencies Management

To manage dependencies, we use npm

To update dependencies, execute: npm upgrade --save

How to run development mode

To run development mode frontend, execute: npm run serve

How to lint your code

To lint your code, execute: npm run lint

How to build

To build frontend, execute: npm run build


Storage

The storage is based on:

  • Postgres to store data
  • gorm to serve as an interface between backend and storage