https://github.com/metriql/metriql
The metrics layer for your data. Join us at https://metriql.com/slack
https://github.com/metriql/metriql
analytics big-data dbt olap
Last synced: about 2 months ago
JSON representation
The metrics layer for your data. Join us at https://metriql.com/slack
- Host: GitHub
- URL: https://github.com/metriql/metriql
- Owner: metriql
- License: apache-2.0
- Created: 2021-05-23T22:29:05.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-29T22:11:05.000Z (almost 3 years ago)
- Last Synced: 2024-06-28T08:04:21.224Z (over 1 year ago)
- Topics: analytics, big-data, dbt, olap
- Language: Kotlin
- Homepage: https://metriql.com
- Size: 1.77 MB
- Stars: 288
- Watchers: 7
- Forks: 23
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-java - Metriql
README
# Metriql
[](#contributors-)
Metriql is an open-source metrics store which allows companies to define their metrics as code and share them across their BI and data tools easily.
It uses [dbt](https://getdbt.com) for the transformation layer and integrate with dbt via its [manifest.json artifact](https://docs.getdbt.com/reference/artifacts/manifest-json).
You can learn more about metriql from [here](https://metriql.com/introduction/intro).
This is the core repository of the [metriql](http://metriql.com) project. It includes the JDBC driver, REST API, and the CLI.
## Integrations
* [metriql CLI](https://metriql.com/metriql-cli/cli-overview)
* [REST API](https://metriql.com/integrations/rest-api)
* [JDBC Driver](https://metriql.com/integrations/jdbc-driver)
* [BI tools](https://metriql.com/integrations/bi-tools/index)
* [Embedded Applications](https://metriql.com/integrations/embedded)
## Running Metriql in your IDE
Run the following commands to pull Metriql and build it locally:
```
git clone https://github.com/metriql/metriql.git
cd metriql
./mvnw clean install -DskipTests
cd ./frontend && npm run build
```
We suggest using Intellij, here are the configuration that you need to run Metriql locally. Here is the required configuration:
```
Main class: com.metriql.ServiceStarterKt
Program arguments: serve --jdbc --manifest-json "https://metriql.github.io/metriql-public-demo/manifest.json"
```
Once you're with the setup, please make sure that:
* [dbt profile setup](https://docs.getdbt.com/dbt-cli/configure-your-profile) is done for Metriql to connect your database.
* [Additional dependencies](https://github.com/metriql/metriql/blob/master/Dockerfile#L27) are installed locally for Metriql to integrate with downstream tools.
## Goodreads
* [Metriql launch post](https://metriql.com/blog/introducing-metriql-open-source-metrics-store)
* [OLAP in the modern data stack](https://metriql.com/blog/2021/09/07/olap-in-modern-data-stack)
* [How we built Metriql Public Demo](https://metriql.com/blog/2021/09/29/how-we-built-our-public-demo)
## Contributors ✨
We're currently hiring a senior software engineer in [UK](https://grnh.se/afd382051us) & [France](https://grnh.se/fe7d05711us) if you'd like to join our team and help us build the next big thing in the modern data stack!