README.md
November 21, 2024 · View on GitHub
Interactive SQL Notebooks | Powered by DuckDB
📝 Table of Contents
- 📝 Table of Contents
- 🧐 About
- 🏁 Getting Started
- 🚀 Deployment
- 💬 Contribute
- ⛏️ Built Using
- 🎉 Acknowledgements
🧐 About
DuckLab provides local SQL notebook experience for adhoc data analysis. It uses DuckDB to process your data within browser and VS Code. 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.
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 install
# 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
- Create an issue and provide your reasoning on why you want to add this feature.
- Discuss your approach and design.
- Implement the feature and submit your PR.
Request a new feature
- Open an issue and provide details about your feature request.
- In case other tools implement that functionality then it will be helpful to share the reference for inspiration and design.
Fix a bug
- If you are resolving an issue, please add fix: #
in your PR title (e.g.fix: #3899 update entities encoding/decoding). - Provide a short description of the bug in your PR and/or link to the issue.