Add qsv, qsv pro & setup, qsv web, & GitHub setup

Co-authored-by: Abdurrahman <mabdurrahman303@gmail.com>
This commit is contained in:
rzmk 2024-02-26 18:55:10 -05:00
parent b5b3788fa6
commit 8e6b0ca3d1
No known key found for this signature in database
30 changed files with 8817 additions and 220 deletions

View file

@ -1,24 +0,0 @@
name: Test deployment
on:
pull_request:
branches:
- main
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
jobs:
test-deploy:
name: Test deployment
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 18
cache: npm
- name: Install dependencies
run: npm ci
- name: Test build website
run: npm run build

View file

@ -2,36 +2,54 @@
sidebar_position: 7 sidebar_position: 7
--- ---
# 🐱‍💻 GitHub # 🖥 GitHub Setup
## 👋 Welcome!
## Welcome Future Coders! 👩‍💻👨‍💻 You may have seen GitHub before or heard about it, and now it's time to learn more and set up your GitHub account!
GitHub is your new best friend in the coding universe! 🚀 Whether you're building the next big app or learning the ropes of coding, GitHub is where the magic happens. Let's get you started on this coding adventure! ## 💭 What's GitHub?
## What's GitHub? 🌐 GitHub is like a virtual playground for coders. You may store your code, share it with others, and even collaborate on projects using Git.
GitHub is like a virtual playground for coders. It's where you store your code, work with others, and make amazing things together. Imagine it as a superhero team for coding projects. :::info Git & GitHub: What's the difference?
## Cool Features 🌈 - **Git** is a version control system (also a command line tool) which can assist in managing code history.
- **GitHub** is a service where code can be hosted.
- **Version Control:** Think of it as a time machine for your code. You can go back to previous versions if something goes wrong. Cool, right? There are many more differences and explanations, so feel free to take a search in your search engine!
- **Collaboration:** Work with friends (or strangers) on projects. Coding is more fun when it's a team effort!
- **Issues & Pull Requests:** Communicate and make changes without stepping on each other's toes. It's like passing notes but cooler.
## Your GitHub Quest 🚀 :::
1. Create a GitHub account at [github.com](https://github.com) - it's like getting your own superhero costume! ## ✨ Cool Features
2. Explore projects. Find something interesting, like a quest you want to join.
3. Fork a project. It's like claiming your own part of the superhero team's headquarters.
4. Make changes and create a Pull Request. Show off your coding skills and suggest improvements.
## Your GitHub Super Move: Collaboration 💻 Here are some _very_ brief descriptions of features you may find often using GitHub:
GitHub is not just for code; it's for making cool things together. Try collaborating on a project, and you'll feel the coding magic! | Feature | Brief description |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| Version control | GitHub can host code repositories which use Git, and GitHub provides a GUI that works with Git |
| Collaboration | Work with friends, coworkers, or even anyone random users from around the world on projects |
| Issues | Track ideas, tasks, feedback, bugs, plans, and more |
| Pull requests | Propose a set of (code) changes from one branch to another and review changes (commonly abbreviated as 'PR') |
| Projects | Project management tool that can help keep track of issues & PRs, including views like [kanban boards](/technical-writing/kanban-board) & tables |
| Discussions | Similar to an online forum, another avenue for a repository's community to connect |
## Ready to Code? 🚀 There are plenty more features GitHub has to offer. Get started with GitHub by following the quest below!
GitHub is your launchpad into the coding galaxy. Explore, collaborate, and let's make coding an epic adventure together! ## 🗺 Your GitHub Quest
Get ready for a coding journey full of challenges, triumphs, and a lot of fun! 🚀🌟 1. Create a GitHub account at [github.com](https://github.com).
2. Explore repositories and find one you think is interesting.
3. Skim the issues for the repository and see if you think you can solve one of them.
4. Fork the repository.
5. Clone the fork to your device, make changes, push the changes to your fork, then create a PR to the original repository.
If you get stuck, are not sure what something means, or can't find an issue that you think you can solve, try searching on your search engine and if that doesn't work then contact your team.
## 💻 Your GitHub Super Move: Collaboration
GitHub is not just for code; it's for making cool (and hopefully useful!) things together. Try collaborating on a project, and have fun working with people around the world!
## 🚀 Ready to code?
Explore, collaborate, and have fun coding! 👋

View file

@ -2,47 +2,47 @@
sidebar_position: 6 sidebar_position: 6
--- ---
# ⚙️ qsvPro Setup # ⚙️ qsv pro Setup
## About qsv pro
# About qsv pro 🚀 Welcome to qsv pro, a powerful desktop app designed for spreadsheet data wrangling. Built on the foundation of the [qsv CLI tool](/qsv/qsv-cli), qsv pro offers a feature-packed local GUI for an enhanced user experience.
## 🏗 Built with
Welcome to qsv pro, a powerful desktop app designed for spreadsheet data wrangling. Built on the foundation of the qsv CLI tool, qsv pro offers a feature-packed local GUI for an enhanced user experience. - **Tauri:** Application framework
- **Next.js:** Web framework
## Key Technologies Used 🛠️ - **shadcn:** UI library
- **Tailwind CSS:** CSS framework
- **Tauri:** Application framework - **release-it:** Release automation tool
- **Next.js:** Web framework - **pnpm:** Package manager
- **shadcn:** UI library - **TypeScript:** Programming language
- **Tailwind CSS:** CSS framework - **Rust:** Programming language
- **release-it:** Release automation tool
- **pnpm:** Package manager
- **TypeScript:** Programming language
- **Rust:** Programming language
Explore the extensive capabilities of qsv pro, making data manipulation a seamless and efficient process. Explore the extensive capabilities of qsv pro, making data manipulation a seamless and efficient process.
Learn more about qsv pro at [qsvpro.dathere.com](https://qsvpro.dathere.com). Learn more about qsv pro at [qsvpro.dathere.com](https://qsvpro.dathere.com) or read [the intern guide post](/qsv/qsv-pro).
# Installation Guide 📥 ## 🗺 Installation Guide
Follow these steps to install and test qsv pro on your system. Follow these steps to install and try out qsv pro on your system.
#### Step 1: Download the Installer 🌐 ### 📥 Step 1: Download the Installer
- Visit the [qsv pro Releases](https://github.com/dathere/qsv-pro-releases/releases) page on GitHub. Visit the [qsv pro Releases](https://github.com/dathere/qsv-pro-releases/releases) page on GitHub.
#### Step 2: Choose the Installer Package 💻 ### 💻 Step 2: Choose the Installer Package
- Select the installer package compatible with your operating system from the assets section. Select and download the installer package compatible with your operating system.
#### Step 3: Installation Procedure 🚀 ### 🛠 Step 3: Installation Procedure
- Complete the installation procedure following the on-screen instructions for your operating system. Run the installer and complete the installation procedure following the on-screen instructions for your operating system.
#### Step 4: Testing (Under Development) 🧪 ### 🧪 Step 4: Testing (Under Development)
- Explore qsv pro's functionalities to ensure a comprehensive test. Manipulate spreadsheets, navigate the user interface, and provide valuable feedback to the development team. Explore qsv pro's features! Manipulate spreadsheets, navigate the user interface, and provide valuable feedback to the development team.
Experience the efficiency and convenience of qsv pro for all your data wrangling needs! ### 🚀 Step 5: Have fun!
Have fun experiencing the efficiency and convenience of qsv pro's data wrangling capabilities on your computer!

View file

@ -1,8 +1,8 @@
{ {
"label": "🕹️ qsv", "label": "⚡ qsv",
"position": 3, "position": 3,
"link": { "link": {
"type": "generated-index", "type": "generated-index",
"description": "Let's Dive into qsv" "description": "Learn about qsv, the data wrangling tool!"
} }
} }

48
docs/qsv/qsv-cli.mdx Normal file
View file

@ -0,0 +1,48 @@
# ⚡ qsv
Meet **qsv**, your new command line tool for data wrangling!
## 💭 What's qsv?
qsv is a command line tool with 50+ commands that can perform data wrangling tasks in a relatively efficient manner.
For example, if I had a csv file that looked like this:
```csv title=prices.csv
id,fruit,cost
1,apple,5.00
2,banana,10.00
3,celery,2.00
```
Then I can use qsv to perform all sorts of commands based on the data. Maybe I want to simply count how many rows there are (not including the header row). I can run:
```bash
qsv count prices.csv
```
And the output would be `3`. But I can add flags for even more options like additionally getting the number of characters in the longest row by adding `--width` (e.g., `qsv count prices.csv --width`), and other commands also have subcommands!
## ✨ Cool Features
- **50+ commands:** There's plenty of options for users for all sorts of backgrounds to use qsv in their workflow
- **Blazingly fast:** qsv is built primarily with the Rust programming language, offering fast speeds even for very large datasets
- **Mix and match:** Combine different qsv commands and integrate qsv with other tools to enhance data wrangling
## 🛠 Install qsv
1. [Install qsv](/onboarding/qsv-setup).
2. Once installed, run `qsv --list` to list the commands available to you, and you can further learn about them by running `qsv <command> --help` where `<command>` is the command you want to learn about (e.g., `qsv count --help`).
3. Try running qsv commands on your files!
## 📊 Your first command: `qsv count`
Navigate to your desired `.csv` file on the terminal and try typing `qsv count <filename>` (where `<filename>` is the name of your file) and see what happens!
See if you can try following along in [the intro-to-count.ipynb notebook](https://nbviewer.org/github/jqnatividad/qsv/blob/master/contrib/notebooks/intro-to-count.ipynb).
## 🚀 Ready for some data wrangling?
That's just the beginning! Explore more commands, use qsv to perform various transformations, and have fun wrangling data with qsv!
Remember, qsv can help make data exciting and easy, even if you're just starting on your data journey!

63
docs/qsv/qsv-pro.mdx Normal file
View file

@ -0,0 +1,63 @@
# 💻 qsv pro
Get ready to level up your data game with **qsv pro**! 🚀
## 💭 What's qsv pro?
qsv pro is a spreadsheet data wrangling desktop app.
It offers a graphical user interface (GUI) based on the [qsv](/qsv/qsv-cli) command line interface (CLI).
## ✨ Super Features
### Spreadsheet data table viewer
![Data table viewer demo](/img/docs/qsv/qsv-pro/data-table-viewer.gif)
### Stats, frequency, and metadata data tables
import metaDemo from "/img/docs/qsv/qsv-pro/stats-frequency-metadata-demo.mp4";
<video width="100%" autoPlay loop>
<source src={metaDemo} type="video/mp4" />
</video>
### Recipes (scripts) to transform data
import recipesDemo from "/img/docs/qsv/qsv-pro/recipes-demo.mp4";
<video width="100%" autoPlay loop>
<source src={recipesDemo} type="video/mp4" />
</video>
### CKAN upload workflow
> The upload feature is getting a major update soon!
import uploadDemo from "/img/docs/qsv/qsv-pro/legacy-upload-demo.mp4";
<video width="100%" autoPlay loop>
<source src={uploadDemo} type="video/mp4" />
</video>
### Resizable panels
import resizablePanelsDemo from "/img/docs/qsv/qsv-pro/resizable-panels-demo.mp4";
<video width="100%" autoPlay loop>
<source src={resizablePanelsDemo} type="video/mp4" />
</video>
### Light & Dark themes
![Theme switch demo](/img/docs/qsv/qsv-pro/themes-demo.gif)
## 🌊 Let's Dive In!
1. [Set up qsv pro](/onboarding/qsv-pro-setup).
2. Launch qsv pro and explore the various features on your files. Just drag and drop a spreadsheet (CSV, Excel file, and more) into qsv pro and watch what happens!
3. Share your experience with your team and provide feedback to the developers.
## 🚀 Ready for a pro experience?
View, transform, and upload your spreadsheets with a streamlined GUI using qsv pro.

70
docs/qsv/qsv-web.mdx Normal file
View file

@ -0,0 +1,70 @@
# 🖱 qsv.dathere.com
qsv is also available on the web! A subset of qsv commands are available to run at [qsv.dathere.com](https://qsv.dathere.com).
## 🌱 Benefits
Here are some benefits of qsv.dathere.com:
- 👋 **User-Friendly Interface**: Built with daisyUI, qsv.dathere.com is a neat way to interact with qsv
- 🔌 **No Installation Required**: Hosted on the web and powered by the qsv CLI, no need to install the qsv CLI or qsv pro GUI
- 📱 **Platform Independence**: Simply go to the web app on a desktop/mobile browser
- 📊 **Interactive Data Previews**: A data table is generated based on command outputs
## 🌐 Accessing qsv.dathere.com
To access the qsv.dathere.com, simply visit the website: [qsv.dathere.com](https://qsv.dathere.com). It's a user-friendly platform that provides powerful data manipulation tools with just a few clicks. 🚀
## 🗺 UI Overview
### 🏡Home
"Home" is your starting point for qsv.dathere.com, a welcome page where you may begin browsing.
![Home GIF](/img/docs/qsv/qsv-web/home.gif)
### 🌐 Web
"Web" is where you may run various qsv commands on your file(s) with a point-and-click UI without having to type any CLI commands.
![Web GIF](/img/docs/qsv/qsv-web/web.gif)
### ⏱️ Benchmarks
"Benchmarks" is where you may data on qsv's performance and compare against previous versions of qsv.
![Benchmarks GIF](/img/docs/qsv/qsv-web/benchmarks.gif)
## 💻 Web commands
On the Web commands page, you'll find a grid of qsv commands with brief descriptions, many of which you may use in the browser.
Simply click on the qsv command you want to use, provide your input file(s), select various flags and potentially subcommands, then press the run button.
:::info Why can't I select certain commands?
Certain commands are unavailable since there currently isn't an automated process for integrating qsv into a web UI, so many commands were manually added for the web app.
:::
![Web commands GIF](/img/docs/qsv/qsv-web/web-commands.gif)
## Command example
For instance, let's choose the "behead" command.
This is a relatively simple command that removes the first row from your CSV, removing the header row.
| Upload by clicking the 'Choose File' button | or Drag and Drop |
| :-----------------------------------------------------------: | :----------------------------------------------------------------------: |
| ![File upload example](/img/docs/qsv/qsv-web/file-upload.png) | ![Drag and drop example](/img/docs/qsv/qsv-web/drag-and-drop-upload.png) |
Once you've uploaded the CSV file you want to work with, simply click on the 'RUN BEHEAD!' button and see what happens!
![Run button example](/img/docs/qsv/qsv-web/run-button-example.gif)
![Command preview](/img/docs/qsv/qsv-web/command-preview.png)
![Data table preview](/img/docs/qsv/qsv-web/data-table-preview.png)
![Raw output preview](/img/docs/qsv/qsv-web/raw-output-preview.png)

View file

@ -1,36 +0,0 @@
# 🚴 qsv
## 🏁 Getting Started with qsv Guide
---
Let's Dive into qsv: Your Data Magic Wand
---
# Hey Interns! 👋
Meet **qsv** - your new best friend for making data do cool stuff! 🚀 Just imagine it as a magic wand for numbers and words (but in computer language).
### What's qsv? 🧙‍♂️
Okay, so qsv is like a super-smart tool that helps us play with tables of information (think Excel sheets, but cooler). It can do tricks like sorting, filtering, and changing data super fast!
### Cool Features ✨
- **Magic Commands:** Tell qsv what you want to do, and it does it like magic! ✨
- **Speedy Gonzales:** Even if there's a lot of data, qsv doesn't get tired. It's like the Flash of data tools!
- **Mix and Match:** Combine different commands to create your own data potions! 🧪
### Let's Try It Out! 🚀
- 1. Open your computer and go to [qsv's home](https://qsv.dathere.com).
- 2. Follow the instructions to install qsv (it's like installing a game, but cooler).
- 3. Once installed, open qsv and start typing commands. It's like giving orders to your data!
### Your First Command: `qsv count` 📊
Navigate to your desired csv file on the terminal and try typing `qsv count` and see what happens! It counts stuff in your data. Easy, right?
### Ready for Some Magic? ✨
That's just the beginning! Explore more commands, ask qsv to do different tricks, and let's have fun with data together.
Remember, qsv is here to make data exciting and easy, even if you're just starting your magical journey! 🌟

View file

@ -1,32 +0,0 @@
# 🏎️ qsvPro
## 🏁 Getting Started with qsvPro Guide
---
qsv Pro: Your Data Playground
---
# Hey Interns! 👋
Get ready to level up your data game with **qsv Pro**! 🚀 Imagine qsv, but with a cool suit and a bunch of extra features. Let's dive into the world of data fun!
### What's qsv Pro? 🧙‍♂️
qsv Pro is like qsv's big brother - it does everything qsv does and more! It's like having a superhero version of your data magic wand.
### Super Features ✨
- **Spreadsheets on Steroids:** qsv Pro has a sleek desktop app that makes working with data feel like playing a game.
- **Fancy Tricks:** It can do advanced tricks like transforming data, visualizing data, and making your data look super fancy.
- **Awesome GUI:** Say goodbye to boring commands! qsv Pro has a visual interface that's as easy as playing a video game.
### Let's Dive In! 🚀
1. Go to [qsv Pro's secret lair](https://qsvpro.dathere.com) on the internet.
2. Follow the instructions to install qsv Pro (it's like getting a power-up in a game).
3. Open qsv Pro and explore the magic. Click buttons, try different features!
### Ready for Superpowers? ✨
qsv Pro is here to turn you into a data superhero! Explore, play, and let's make data fun and powerful together.
s
Remember, qsv Pro is your ticket to the advanced world of data - where every click feels like a super move! 🌟

View file

@ -1,77 +0,0 @@
# 🏍️ qsv.dathere.com
## 🏁 Getting Started with qsv Web Version Guide
### Introduction:
qsv (pronounced "Quicksilver") is a command line program
for querying, indexing, slicing, analyzing, filtering, enriching,
transforming, sorting, validating & joining CSV files.
Commands are simple, fast & composable
| **Benefits of QSV Web** |
|---------------------------|
| ✨ **User-Friendly Interface** |
| 🚀 **No Installation Required** |
| 🌐 **Platform Independence** |
| 📊 **Interactive Data Previews** |
### 🌐 Accessing qsv Web Version
To access the qsv Web Version, simply visit our website at [qsv.dathere.com](qsv.dathere.com). It's a user-friendly platform that provides powerful data manipulation tools with just a few clicks. 🚀
### Interface Overview
#### 🏡Home
"Home" is your starting point for qsv's Web Version. It takes you to the welcoming homepage where you can begin your data journey.
![home GIF](/img/docs/qsv.dathere.com/home.gif)
#### 👩‍💻 Web
"Web" is where you access qsv's user-friendly web commands, simplifying data tasks with a click.
![Web GIF](/img/docs/qsv.dathere.com/Web.gif)
#### ⏱️ Benchmarks
"Benchmarks" is where you find data on qsv's performance and evolution. Explore performance stats and metrics here.
![benchmarks GIF](/img/docs/qsv.dathere.com/Benchmarks.gif)
### 👩‍💻 Web Commands
On the Web Commands page, you'll find an array of icons representing various qsv commands,
each designed to tackle specific data tasks.
Simply click on the icon related to your task, and let qsv work its magic. It's that easy!
:::info Why can't I select few commands? 🚫
Though the website is up and running there are few commands which are not fully integrated on the web version
:::
![web Commands GIF](/img/docs/qsv.dathere.com/webcommands.gif)
### Command Example
For instance, let's choose the "behead" command, one of qsv's fundamental tools.
This command serves the purpose of removing CSV file headers, setting the stage for your data operations.
Upload using file explorer | or Drag n' Drop
:-------------------------:|:-------------------------:
![](![benchmarks GIF](/img/docs/qsv.dathere.com/upload2.png) ) | ![](![benchmarks GIF](/img/docs/qsv.dathere.com/upload.png) )
Once you've uploaded the CSV file you want to work with, simply click on the 'RUN' button and see what happens!
![benchmarks GIF](/img/docs/qsv.dathere.com/run.gif)
![benchmarks GIF](/img/docs/qsv.dathere.com/Command_Preview.png)
![benchmarks GIF](/img/docs/qsv.dathere.com/Data_table_preview.png)
![benchmarks GIF](/img/docs/qsv.dathere.com/Raw_Output_Preview.png)

8567
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load diff

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 102 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 MiB

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

After

Width:  |  Height:  |  Size: 103 KiB

View file

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 36 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 31 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 27 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 29 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 32 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 26 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 833 KiB

After

Width:  |  Height:  |  Size: 833 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 2.6 MiB

After

Width:  |  Height:  |  Size: 2.6 MiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 176 KiB

After

Width:  |  Height:  |  Size: 176 KiB

Before After
Before After