/bdash-server

A knowledge sharing platform for data analysts - Share and search SQL queries

Primary LanguageTypeScript

Bdash Server

This is a web app to share SQLs for data analysis from Bdash.

The features are:

  1. Share as a web page your SQL, query results and charts from Bdash client.
  2. Add descriptions to your query.
  3. Search queries of all users.

screenshot

Bdash Server is powered by Blitz.js using Next.js and Prisma.

Setup

Make your own .env.local from .env.local.example for development.

$ cp .env.local.example .env.local

And write your own GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET for OAuth.

You can generate OAuth web client ID by following the steps described in: https://support.google.com/workspacemigrate/answer/9222992.

After that,

  • Set http://localhost:3000 as Authorized JavaScript origins
  • Set http://localhost:3000/api/auth/google/callback as Authorized redirect URIs

Run

$ yarn dev

Docker is required. 🐳

Run db:migrate to setup database.

$ yarn db:migrate

Open http://localhost:3000 with your browser to see the result.

Run production mode (NODE_ENV=production) on local machine

Run an app container with the image built by Dockerfile for production.

docker compose -f docker-compose-with-app-container.yml up --build

Tests

yarn test

License

MIT