HassaanAkbar / ducklab

In-browser data analysis using SQL | Powered by duckdb-wasm

Home Page:https://ducklab.netlify.app/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Project logo

Status License GitHub Issues License


In-browser interactive SQL Notebooks | Powered by duckdb-wasm

πŸ“ Table of Contents

🧐 About

DuckLab provides in-browser, SQL notebook experience for adhoc data analysis. It uses duckdb-wasm to process your data within browser. No data leaves your machine.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Install NodeJs 16 or above.

https://nodejs.org/

Installing

A step by step series of examples that tell you how to get a development env running.

It is recommended to use pnpm,

# Install pnpm (if you don't have it installed already)
npm i -g pnpm

# install dependencies
pnpm imstall

# Start the dev server
pnpm run dev

Or if you are using npm

# install dependencies
npm install

# start the dev server
npm run dev

πŸš€ Deployment

Application has no backend, build can be generated using pnpm run build and dist folder can be deployed as a static application on any static site hosting.

πŸ’¬ Contribute

Contributions are most welcome. There are various ways you can contribute,

Implement a new feature

  1. Create an issue and provide your reasoning on why you want to add this feature.
  2. Discuss your approach and design.
  3. Implement the feature and submit your PR.

Request a new feature

  1. Open an issue and provide details about your feature request.
  2. In case other tools implement that functionality then it will be helpful to share the reference for inspiration and design.

Fix a bug

  1. If you are resolving an issue, please add fix: # in your PR title (e.g.fix: #3899 update entities encoding/decoding).
  2. Provide a short description of the bug in your PR and/or link to the issue.

⛏️ Built Using

πŸŽ‰ Acknowledgements

About

In-browser data analysis using SQL | Powered by duckdb-wasm

https://ducklab.netlify.app/

License:Apache License 2.0


Languages

Language:TypeScript 57.0%Language:Vue 40.9%Language:Less 1.3%Language:JavaScript 0.4%Language:HTML 0.4%