Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robertaboukhalil/jqkungfu
A jq playground, written in WebAssembly
https://github.com/robertaboukhalil/jqkungfu
jq wasm webassembly
Last synced: 2 months ago
JSON representation
A jq playground, written in WebAssembly
- Host: GitHub
- URL: https://github.com/robertaboukhalil/jqkungfu
- Owner: robertaboukhalil
- License: mit
- Created: 2019-02-15T14:04:38.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-12-01T04:14:47.000Z (10 months ago)
- Last Synced: 2024-06-25T19:01:57.390Z (3 months ago)
- Topics: jq, wasm, webassembly
- Language: HTML
- Homepage: http://jqkungfu.com
- Size: 3 MB
- Stars: 136
- Watchers: 5
- Forks: 20
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jq kung fu
A [jq](https://github.com/stedolan/jq/) playground, powered by WebAssembly.
## Links
* [jqkungfu.com](https://jqkungfu.com)
* [sandbox.bio's jq Playground](https://jqkungfu.com)
* [jq Tutorial](https://sandbox.bio/tutorials?id=jq-intro)
* [Use jq in your own web apps](https://github.com/biowasm/biowasm/tree/main/tools/jq#jqwasm)
## How?
jqkungfu was built by compiling [jq](https://github.com/stedolan/jq/) to WebAssembly, so that it runs in the browser.
The advantages of this approach are:
* **Speed**: After the initial load time, jq queries are very fast because there are no round trips to a server
* **Security**: This approach runs jq within the browser; otherwise, we would need to carefully secure the app so that users can't run arbitrary commands on the server!
* **Convenience**: The app is purely front-end and is hosted as static files on a cloud storage provider
## Launch locally
To launch jqkungfu locally:
```bash
python3 -m http.server 9999
```
Then open [http://localhost:9999](http://localhost:9999) in your browser.
## Compile to WebAssembly (optional)
To compile jq to WebAssembly, run the `compile.sh` code within an environment that includes [Emscripten](https://github.com/emscripten-core/emscripten).
To set up your environment:
```sh
# Make sure to use "--recursive" so the jq submodule is initialized
$ git clone --recursive https://github.com/robertaboukhalil/jqkungfu.git
# Build the Docker image with needed dependencies
$ docker buildx build -t jqkungfu .
# Compile to WebAssembly
$ docker run --rm -it -v .:/src --entrypoint ./compile.sh jqkungfu
```
## Learn More
This app is part of an example built for my book [Level up with WebAssembly](https://levelupwasm.com). Check it out if you're interested in more details, or to learn how to create similar applications.