https://github.com/owenthereal/jqplay

A jq playground built with Next.js
https://github.com/owenthereal/jqplay

jq nextjs playground wasm webassembly

Last synced: about 7 hours ago
JSON representation

A jq playground built with Next.js

• Host: GitHub
• URL: https://github.com/owenthereal/jqplay
• Owner: owenthereal
• License: mit
• Created: 2014-03-20T22:38:30.000Z (almost 11 years ago)
• Default Branch: main
• Last Pushed: 2025-01-14T22:31:57.000Z (4 days ago)
• Last Synced: 2025-01-18T04:18:06.725Z (about 20 hours ago)
• Topics: jq, nextjs, playground, wasm, webassembly
• Language: Go
• Homepage: https://jqplay.org
• Size: 44.4 MB
• Stars: 746
• Watchers: 22
• Forks: 88
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# jqplay

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 [jqplay.org](https://jqplay.org)!**

## How It Works

- **WebAssembly-Powered**: jqplay 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/owenthereal/jqplay

cd jqplay

```

### 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 jqplay.

### 3. Run a Production Build

For a production-ready build, use:

```console

npm run build

npm run start

```

Open your browser to  to use jqplay locally in production mode.

## Contributing

Contributions are welcome! 🎉 Whether you’re fixing bugs, adding features, or improving documentation, your help is appreciated.

## License

📜 jqplay is licensed under the [MIT License](LICENSE).

---

Happy querying! 🚀