release 0.1.0

Author: owlas

.dockerignore

@@ -0,0 +1,34 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/packages/frontend/build
+/packages/common/dist
+/packages/backend/dist
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+.idea
+node_modules
+
+# typescript
+*.tsbuildinfo
+
+# examples
+/dbt

.env

@@ -0,0 +1,2 @@
+DBT_PROJECT_DIR=./dbt
+DBT_PROFILE_DIR=~/.dbt

.gitignore

@@ -0,0 +1,35 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/packages/frontend/build
+/packages/common/dist
+/packages/backend/dist
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+.idea
+node_modules
+
+# typescript
+*.tsbuildinfo
+
+# examples
+/dbt
+/profile*

README.md

@@ -0,0 +1,86 @@
+# lightdash
+
+lightdash removes the gap between your data transformation layer and your data visualization layer. It enables data analysts and engineers to control all of their business intelligence (data transformations/business logic as well as data visualization) in a single place.
+
+lightdash integrates with your dbt project and gives a framework for defining metrics and specifying joins between models all within your existing dbt YAML files. The data output from your dbt project is then available for exploring and sharing in lightdash.
+
+- No more scattered, duplicated metrics across multiple tools.
+- No more time spent trying to maintain data changes in both dbt and and your data viz tools.  
+- No more context lost between your data transformation and your data visualization layer.
+
+## Getting Started
+---
+
+### Quickstart with docker
+
+The fastest way to get started is to use [docker](https://docs.docker.com/get-docker/)
+
+```shell
+# Clone the lightdash repo
+git clone https://github.com/lightdash/lightdash
+
+# Enter the repo directory
+cd lightdash
+
+# Specify the path to your dbt project
+# (i.e. the directory containing dbt_project.yml)
+# You MUST use the absolute path (i.e no ../../myrepo)
+export DBT_PROJECT_DIR=/Users/myuser/dbtrepo
+
+# Build and launch lightdash
+docker compose up
+
+# Ready on http://localhost:8080 !
+```
+
+### Installation from source
+
+lightdash requires node.js and yarn.
+
+**Install dependencies for Mac OS**
+```shell
+# Install node with homebrew
+brew install node
+
+# Install yarn with node package manager
+npm install -g yarn
+
+# Clone the lightdash repo
+git clone https://github.com/lightdash/lightdash
+
+# Enter the repo directory
+cd lightdash
+
+# Install lightdash dependencies and build
+yarn install
+yarn build
+```
+
+### Adding dimensions, measures, joins, and more to your lightdash project
+
+lightdash's configuration is fully defined in your dbt project. For example, measures and joins sit in your models' .yml files.
+
+Check out our [example_model.yml](https://github.com/lightdash/lightdash/blob/main/examples/example_model.yml) file for more details on how to add these features to your project! 
+
+### Launching lightdash
+
+```shell
+# Specify the path to your dbt project
+# (i.e. the directory containing dbt_project.yml)
+# You MUST use the absolute path (i.e no ../../myrepo)
+export DBT_PROJECT_PATH=/Users/myuser/dbtrepo
+
+# Build and run lightdash
+yarn start
+
+# Press ALLOW when asked to "accept incoming connections from python"
+```
+
+## Join the community!
+---
+- Find us on [Slack](https://join.slack.com/t/seekercommunity/shared_invite/zt-ptiqsd6p-Dbjjn8GXozYkFhARgAs3cw). We'd love to hear what you have to say about lightdash :)
+- _coming soon_ Join the discussion in our discourse.
+
+## Reporting bugs and feature requests
+---
+- Want to report a bug or request a feature? Let us know on [Slack](https://join.slack.com/t/seekercommunity/shared_invite/zt-ptiqsd6p-Dbjjn8GXozYkFhARgAs3cw), or open an [issue](https://github.com/lightdash/lightdash/issues/new/choose).

docker-compose.yml

@@ -0,0 +1,20 @@
+version: "3.9"
+services:
+  dbt:
+    image: "fishtownanalytics/dbt:0.19.1"
+    volumes:
+      - "${DBT_PROFILE_DIR}:/usr/app/profile"
+      - "${DBT_PROJECT_DIR}:/usr/app"
+    command: ["rpc", "--profiles-dir", "profile", "--host", "0.0.0.0", "--port", "8580"]
+
+  lightdash:
+    build:
+      context: .
+    depends_on: 
+      - dbt
+    environment:
+      - LIGHTDASH_DBT_HOST=dbt
+      - LIGHTDASH_DBT_PORT=8580
+      - LIGHTDASH_SPAWN_DBT=false
+    ports:
+      - 8080:8080

dockerfile

@@ -0,0 +1,56 @@
+FROM node:14 AS base
+
+WORKDIR /usr/app
+
+# Stage 1: build the common, backend, and frontend distributions
+FROM base AS builder
+
+# Install development dependencies for all
+COPY package.json .
+COPY yarn.lock .
+COPY packages/common/package.json ./packages/common/
+COPY packages/backend/package.json ./packages/backend/
+COPY packages/frontend/package.json ./packages/frontend/
+
+RUN yarn install --pure-lockfile --non-interactive
+
+# Build common
+COPY packages/common/ ./packages/common/
+RUN yarn --cwd ./packages/common/ build
+
+# Build backend
+COPY packages/backend/ ./packages/backend/
+RUN yarn --cwd ./packages/backend/ build
+
+# Build frontend
+COPY packages/frontend ./packages/frontend
+RUN yarn --cwd ./packages/frontend/ build
+
+# Stage 2: execution environment for backend
+FROM base as executor
+
+# Copy distributions into environment
+COPY --from=builder /usr/app/packages/common/package.json /usr/app/packages/common/package.json
+COPY --from=builder /usr/app/packages/common/dist /usr/app/packages/common/dist
+
+
+COPY --from=builder /usr/app/packages/backend/package.json /usr/app/packages/backend/package.json
+COPY --from=builder /usr/app/packages/backend/dist /usr/app/packages/backend/dist
+
+
+COPY --from=builder /usr/app/packages/frontend/package.json /usr/app/packages/frontend/package.json
+COPY --from=builder /usr/app/packages/frontend/build /usr/app/packages/frontend/build
+
+# Install production dependencies
+COPY package.json .
+COPY yarn.lock .
+
+ENV NODE_ENV production
+
+RUN yarn install --pure-lockfile --non-interactive --production
+
+# Run the backend
+WORKDIR /usr/app/packages/backend
+
+USER node
+CMD ["yarn", "start"]

examples/example_model.yml

@@ -0,0 +1,54 @@
+version: 2
+
+models:
+  - name: users # In lightdash, the model name will match the name you define here.
+    description: "One row per user_id. This is a list of all users and aggregated information for these users."
+
+    # If we want to join this model to other models in lightdash, we need to define this in the .yml file.
+    # We add joins at the same indentation level as our model's name, description, etc. in a `meta` block
+    # You can join multiple models other models to your model.
+    # All joins are left-outer joins.
+    meta:
+        joins:
+          - join: segment_web_sessions # name of model you're joining to
+            left_on: user_id # join key of left model (i.e. this model)
+            right_on: user_id # join key of right model (i.e. model you're joining)
+          - join: payments
+            sql_on: ${users.user_id} = ${segment_web_sessions.blended_user_id} # you can also write the join in SQL instead of using the left_on, right_on syntax
+
+
+    # For a column to appear in lightdash, it needs to be defined in the model's .yml file.
+    # To define a column, you only need to include the column name (descriptions are optional).
+    # All of the column descriptions are automatically pulled into lightdash.
+    columns:
+      - name: user_id
+        description: 'Unique identifier for a user.'
+        tests:
+          - unique
+          - not_null
+
+        # We add measures in lightdash in a `meta` block within the column definition.
+        # A single column can have multiple measures.
+        meta:
+          measures:
+            - name: num_unique_users # this is the name of the measure.
+              type: count_distinct # this is the type of calculation that's being done
+            - name: num_unique_7d_active_users
+              description: "Unique number of users that have had at least one web session in the past 7 days." # measures have default descriptions that are added to lightdash. But, you can override these with your own descriptions if you want!
+              type: count_distinct
+      - name: user_activated_date
+        description: "Date ('yyyy-mm-dd') when the user ID was first recorded."
+      - name: days_since_activated
+        description: 'Number of days since the user ID was activated'
+      - name: is_7d_web_active_latest
+        description: 'TRUE/FALSE indicating whether or not the user has had at least 1 web session in the previous 7 days.'
+      - name: num_web_sessions_prev_7d
+        description: 'Total number of web sessions the user has had in the past 7 days'
+        meta:
+          measures:
+            - name: total_num_web_sessions_prev_7d
+              type: sum
+      - name: num_web_sessions_prev_30d
+        description: 'Total number of web sessions the user has had in the past 30 days'
+      - name: num_web_sessions_total
+        description: 'Total number of web sessiosn the user has ever had.'

package.json

@@ -0,0 +1,26 @@
+{
+  "name": "lightdash",
+  "version": "0.1.0",
+  "main": "index.js",
+  "license": "MIT",
+  "private": true,
+  "workspaces": {
+    "packages": [
+      "packages/*"
+    ]
+  },
+  "devDependencies": {
+    "npm-run-all": "^4.1.5"
+  },
+  "scripts": {
+    "common-build": "yarn workspace common build",
+    "backend-dev": "yarn workspace backend dev",
+    "backend-build": "yarn workspace backend build",
+    "backend-start": "yarn workspace backend start",
+    "frontend-dev": "yarn workspace frontend start",
+    "frontend-build": "yarn workspace frontend build",
+    "dev": "run-p backend-dev frontend-dev",
+    "build": "run-p backend-build frontend-build",
+    "start": "run-p backend-start"
+  }
+}

packages/backend/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "backend",
+  "version": "0.1.0",
+  "main": "dist/index",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/express": "^4.17.11",
+    "@types/node": "^14.14.35",
+    "@types/node-fetch": "^2.5.10",
+    "nodemon": "^2.0.7",
+    "ts-node": "^9.1.1",
+    "typescript": "^4.2.3"
+  },
+  "dependencies": {
+    "@types/morgan": "^1.9.2",
+    "ajv": "^8.3.0",
+    "ajv-formats": "^2.1.0",
+    "common": "1.0.0",
+    "execa": "^5.0.0",
+    "express": "^4.17.1",
+    "fuse.js": "^6.4.6",
+    "morgan": "^1.10.0",
+    "node-cache": "^5.1.2",
+    "node-fetch": "^2.6.1"
+  },
+  "scripts": {
+    "dev": "nodemon src/index.ts",
+    "build": "tsc --build tsconfig.json",
+    "start": "node dist/index.js"
+  }
+}