https://github.com/bdash-app/bdash-server
A knowledge sharing platform for data analysts - Share and search SQL queries
https://github.com/bdash-app/bdash-server
Last synced: 13 days ago
JSON representation
A knowledge sharing platform for data analysts - Share and search SQL queries
- Host: GitHub
- URL: https://github.com/bdash-app/bdash-server
- Owner: bdash-app
- Created: 2021-04-04T14:17:20.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-14T08:03:44.000Z (3 months ago)
- Last Synced: 2025-04-01T04:08:55.750Z (about 1 month ago)
- Language: TypeScript
- Homepage:
- Size: 702 KB
- Stars: 25
- Watchers: 2
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Bdash Server
This is a web app to share SQLs for data analysis from [Bdash](https://github.com/bdash-app/bdash).
The features are:
1. Share as a web page your SQL, query results and charts from Bdash client.
1. Add descriptions to your query.
1. Search queries of all users.
Bdash Server is powered by [Blitz.js](https://github.com/blitz-js/blitz) using [Next.js](https://nextjs.org/) and [Prisma](https://www.prisma.io/).
## Setup
Make your own `.env.local` from `.env.local.example` for development.
```sh
$ 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
```sh
$ yarn dev
```
Docker is required. 🐳
Run db:migrate to setup database.
```sh
$ yarn db:migrate
```
Open [http://localhost:3000](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](https://github.com/morishin/bdash-server/blob/main/Dockerfile) for production.
```sh
docker compose -f docker-compose-with-app-container.yml up --build
```
## Tests
```
yarn test
```
## License
MIT