https://github.com/sascha-andres/jsonedit
A web-based JSON editor application
https://github.com/sascha-andres/jsonedit
json utility
Last synced: 2 months ago
JSON representation
A web-based JSON editor application
- Host: GitHub
- URL: https://github.com/sascha-andres/jsonedit
- Owner: sascha-andres
- License: other
- Created: 2025-06-04T08:06:37.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-04-19T16:20:05.000Z (3 months ago)
- Last Synced: 2026-04-19T18:19:44.672Z (2 months ago)
- Topics: json, utility
- Language: Go
- Homepage: https://sascha-andres.github.io/jsonedit/
- Size: 1.22 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Notice: NOTICE
Awesome Lists containing this project
README
# JSON Edit
A web-based JSON editor application.
## Features
- Edit JSON files via a web interface
- Compare JSON files
- Convert CSV to JSON, YAML, or TOML with custom mapping
- Read-only mode option
- Configurable indentation
## Show me
### Home Page
The landing page of the application provides quick access to all main features. From here, you can:
- Create a new JSON document
- Open an existing JSON file
- Access the comparison tool
### JSON Editor
A full-featured JSON editor with syntax highlighting and validation. This view allows you to:
- Edit JSON content
- Save changes to files
### JSON Viewer
A read-only view for JSON documents with collapsible sections. This view is ideal for:
- Reviewing JSON data without risk of accidental changes
### JSON Comparison
A comparison tool that highlights differences between two JSON documents. Features include:
- Visual highlighting of added, modified, and removed elements
### CSV to JSON Converter
A tool that converts CSV data to JSON, YAML, or TOML format using a custom mapping file. Features include:
- Support for custom CSV separators
- Option to wrap output in an array
- Named column mapping
- Conditional property mapping
- Multiple output formats (JSON, YAML, TOML)
- Advanced callback functions for custom record processing and dynamic value generation
For detailed documentation on the command-line utility, see the [csv2json README](cmd/csv2json/README.md).
### Debug Visualizer
An advanced debugging tool available in debug mode that shows:
- HTTP request and response details
- Application logs and events
- Performance metrics
- Request tracing information
Call it at /__viz
## Usage
```bash
# Run with default settings
jsonedit
# Run with custom settings
jsonedit --port 3000 --host 0.0.0.0 --indent " " --read-only
```
## Configuration
The application can be configured using command-line flags or environment variables:
| Flag | Environment Variable | Default | Description |
|------|---------------------|---------|-------------|
| `--port` | `JSON_EDIT_PORT` | 8080 | Port to listen on |
| `--host` | `JSON_EDIT_HOST` | localhost | Host to listen on |
| `--indent` | `JSON_EDIT_INDENT` | " " | Indentation level |
| `--read-only` | `JSON_EDIT_READ_ONLY` | false | Read-only mode |
| `--log-level` | `JSON_EDIT_LOG_LEVEL` | info | Log level (debug, info, warn, error) |
When running in debug mode (by setting `--log-level debug`), the application exposes a `/__viz` endpoint that provides visualization and logging of HTTP requests and responses, which is useful for debugging and development.
## Building and Releasing
This project uses [GoReleaser](https://goreleaser.com/) to build and release binaries for multiple platforms:
- macOS (arm64, amd64)
- Linux (arm64, amd64)
- Windows (amd64)
### Local Testing
To test the build process locally:
```bash
# Install GoReleaser if you haven't already
go install github.com/goreleaser/goreleaser@latest
# Test the build without releasing
goreleaser build --snapshot --clean
```
The built binaries will be available in the `dist/` directory.
### Creating a Release
To create a new release:
1. Tag the commit you want to release:
```bash
git tag -a v0.1.0 -m "First release"
git push origin v0.1.0
```
2. The GitHub Actions workflow will automatically build and release the binaries.
3. The release will be available on the GitHub Releases page.
## Used dependencies
### Go dependencies
This project uses the following dependencies not from the same author:
- [github.com/doganarif/govisual](https://github.com/doganarif/govisual) - Visual debugging tool
- [github.com/google/go-cmp](https://github.com/google/go-cmp) - Package for comparing Go values
- [github.com/google/gops](https://github.com/google/gops) - Tool to list and diagnose Go processes
### Used Fonts
This project uses the following fonts:
- [Monaspace](https://github.com/githubnext/monaspace) - Used for monospaced text
- [Jost](https://github.com/indestructible-type/Jost) - Used for non-monospaced text
## License
This project is licensed under the [Apache License 2.0](LICENSE) - see the [LICENSE](LICENSE) file for details except `internal/csv2json`
### License restrictions
The code in `internal/csv2json` is proprietary, this means:
- It is allowed for use only within the jsonedit product or if explicitly granted by the initial creator
- To abtain a license for usage in a different product or a derivative work contact the repository owner
- A license must be given in written form and does not allow providing licences to third parties
For detailed documentation on the CSV to JSON mapping configuration, see the [internal csv2json README](internal/csv2json/README.md).
#### Fixing issues in internal/csv2json
You may fix issues and/or contribute to internal/csv2json as long as
1. those fixes are contributed back
2. you grant the license to use your changes without any restrictions including licensing to existing and future grantees
You have to document that agreement by providing a signed agreement.