https://github.com/jqlang/playground
A jq playground built with Next.js
https://github.com/jqlang/playground
jq nextjs playground wasm webassembly
Last synced: 22 days ago
JSON representation
A jq playground built with Next.js
- Host: GitHub
- URL: https://github.com/jqlang/playground
- Owner: jqlang
- License: mit
- Created: 2014-03-20T22:38:30.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2025-04-07T17:35:36.000Z (29 days ago)
- Last Synced: 2025-04-09T09:16:35.242Z (27 days ago)
- Topics: jq, nextjs, playground, wasm, webassembly
- Language: TypeScript
- Homepage: https://play.jqlang.org
- Size: 45.5 MB
- Stars: 764
- Watchers: 21
- Forks: 90
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# playground
A [jq](https://jqlang.github.io/jq) playground built with [Next.js](https://nextjs.org).
Test your jq queries against JSON directly in your browser. All jq queries and HTTP requests to fetch JSON are processed **locally** in your browser. Snippets are sent to the server **only** if you choose to share them.
✨ **Try it out at [play.jqlang.org](https://play.jqlang.org)!**
## How It Works
- **WebAssembly-Powered**: it integrates the [jq-wasm](https://github.com/owenthereal/jq-wasm) package, a WebAssembly-based jq JSON processor for Node.js and browsers, with no native dependencies. This ensures that all jq queries run directly in your browser.
- **Local Data Processing**: Your JSON input is processed locally in your browser, ensuring your data stays private and secure.
- **Shareable Snippets**: If you share your jq query, a unique URL is generated on the server. Others can open the shared snippet, but the query will still run locally in their browser.
## Getting Started
Prerequisites
- Node.js (>= 14.x recommended)
- npm or yarn package manager
- PostgreSQL (for storing shared snippets)
## Running the App
### 1. Clone the repository
```console
git clone https://github.com/jqlang/playground
cd playground
```
### 2. Start in Development Mode
To start the app in development mode with hot reload enabled and a local PostgreSQL database:
```console
docker compose up
```
Open your browser to to explore the playground.
### 3. Run a Production Build
For a production-ready build, use:
```console
npm run build
npm run start
```
Open your browser to to use playground locally in production mode.
## Contributing
Contributions are welcome! 🎉 Whether you’re fixing bugs, adding features, or improving documentation, your help is appreciated.
## License
📜 The jq playground is licensed under the [MIT License](LICENSE).
---
Happy querying! 🚀