Skip to content

diazjhozua/json-derule

Repository files navigation

JSON DERULE logo

JSON DERULE πŸ› οΈ

Status GitHub Issues GitHub Pull Requests License


A powerful, modern web application for JSON formatting, validation, and comparison with a sleek dark-mode interface and professional developer experience.

πŸ“ Table of Contents

🧐 About

JSON DERULE is a comprehensive JSON toolkit designed for developers who work with JSON data daily. It combines three essential JSON operations into one elegant, fast, and intuitive web application. Whether you need to format messy JSON, validate syntax, or compare two JSON objects for differences, JSON DERULE provides a professional-grade solution with a beautiful dark-mode interface.

The application features real-time processing, keyboard shortcuts for power users, detailed error reporting, and responsive design that works seamlessly across all devices. Built with modern web technologies, it offers the speed and reliability developers expect from their tools.

✨ Key Features:

  • 🎨 JSON Formatter: Beautiful formatting with customizable indentation
  • βœ… JSON Validator: Real-time validation with detailed error reporting
  • πŸ” JSON Compare: Visual diff with change tracking and statistics
  • πŸŒ™ Dark Mode: Professional dark interface optimized for developers
  • ⚑ Real-time Processing: Instant feedback as you type
  • ⌨️ Keyboard Shortcuts: Efficient workflows for power users

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Make sure you have the following installed on your development machine:

- Node.js (18.0 or later)
- npm or yarn package manager
- Git

Installing

Follow these steps to get your development environment running:

Step 1: Clone the repository

git clone https://github.com/diazjhozua/json-derule.git
cd json-derule

Step 2: Install dependencies

# Using npm
npm install

# Using yarn
yarn install

Step 3: Start the development server

# Using npm
npm run dev

# Using yarn
yarn dev

The application will be available at http://localhost:3000

Step 4: Build for production

# Using npm
npm run build
npm start

# Using yarn
yarn build
yarn start

🎈 Usage

JSON Formatter

  1. Navigate: Go to the Formatter page (default landing page)
  2. Input: Paste your JSON data in the left editor
  3. Format: Click "Format" or press Ctrl+F for beautiful formatting
  4. Minify: Click "Minify" or press Ctrl+M to remove whitespace
  5. Customize: Adjust indentation levels (1-8 spaces)

JSON Validator

  1. Navigate: Click "Validator" in the navigation
  2. Input: Paste JSON data in the editor
  3. Validate: Turn on auto-validate for real-time feedback
  4. Review: View detailed statistics and error reports
  5. Fix: Use helpful suggestions to correct JSON syntax

JSON Compare

  1. Navigate: Click "Compare" in the navigation
  2. Input: Paste JSON objects in both editors
  3. Compare: Enable auto-compare or click "Compare" manually
  4. Review: Examine detailed differences with change statistics
  5. Navigate: Expand sections to see before/after values

Keyboard Shortcuts

  • Ctrl+F: Format JSON
  • Ctrl+M: Minify JSON
  • Ctrl+V: Validate JSON (when auto-validate is off)
  • Ctrl+R: Compare JSON (when auto-compare is off)
  • Ctrl+S: Swap JSON inputs (Compare page)
  • Ctrl+K: Clear all content

✨ Features

🎨 JSON Formatter

  • Beautiful syntax-highlighted formatting
  • Customizable indentation (1-8 spaces)
  • Minification for production use
  • File size analysis and compression ratios
  • Copy-to-clipboard functionality

βœ… JSON Validator

  • Real-time validation with auto-validate mode
  • Detailed error messages with line numbers
  • Comprehensive JSON statistics and analysis
  • Data type breakdown and structure insights
  • Helpful suggestions for common syntax errors

πŸ” JSON Compare

  • Visual diff with color-coded changes
  • Detailed change statistics (added, removed, modified)
  • Expandable sections for detailed before/after comparison
  • Auto-compare mode for real-time diff
  • Type change detection and reporting

πŸ› οΈ Developer Experience

  • Professional dark mode interface
  • Responsive design for all screen sizes
  • Fast, client-side processing
  • Keyboard shortcuts for efficient workflows
  • Accessible design following WCAG guidelines

⛏️ Built Using

✍️ Authors

See also the list of contributors who participated in this project.

πŸŽ‰ Acknowledgements

  • Chakra UI Team for the excellent component library
  • Next.js Team for the amazing React framework
  • TypeScript Team for bringing type safety to JavaScript
  • Monaco Editor for providing the VS Code editing experience
  • JSON.org for the JSON specification and inspiration
  • The open-source community for continuous innovation and support

Happy JSON processing! πŸ› οΈ

About

A powerful, modern web application for JSON formatting, validation, and comparison with a sleek dark-mode interface and professional developer experience.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors