rdenadai/microbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
A compact collection of small, fast, and practical developer utilities—everything in one place. URL shortener, UUID generators, hash tools, QR codes, JSON utilities, encoding/decoding helpers, fake data, and more. Built to be lightweight, modular, and easy to extend as new micro-apps are added. https://microbox.rdenadai.dev
9 commits 4 branches 0 tags 899 KiB
Find a file
Exact
Rodolfo De Nadai af6935060d Merge pull request 'Update README.md' (#3) from rdenadai-patch-1 into main 
Reviewed-on: #3
2025-12-11 18:31:05 +00:00
.vscode feat: Improvements v0.0.3 2025-12-11 09:12:17 -03:00
api feat: Improvements v0.0.3 2025-12-11 09:12:17 -03:00
ui feat: Improvements v0.0.3 2025-12-11 09:37:00 -03:00
.gitignore Initial commit 2025-11-19 19:06:02 +00:00
docker-compose.yml feat: Improvements v0.0.3 2025-12-11 09:12:17 -03:00
LICENSE Initial commit 2025-11-19 19:06:02 +00:00
README.md Update README.md 2025-12-11 18:30:57 +00:00

README.md

Microbox

Microbox Logo

A compact collection of small, fast, and practical developer utilities—everything in one place. URL shortener, UUID generators, hash tools, QR codes, JSON utilities, encoding/decoding helpers, fake data, and more. Built to be lightweight, modular, and easy to extend as new micro-apps are added.

Overview

Microbox is split into two main components:

  • API: Python backend providing services that require server-side processing
  • UI: Vue.js frontend offering both client-side tools and interfaces to API services

Architecture

microbox/
├── api/          # Python/Starlette backend
├── ui/           # Vue 3 frontend
└── docker-compose.yml

Features

Client-Side Tools

These tools run entirely in the browser without API calls:

Tool Description
UUID Generator Generate UUID v1, v3, v4, v5, and v7
Hash Generator Create MD5, SHA1, SHA256, SHA512 hashes
Random String Generator Generate random strings with custom length and character sets
JWT Encoder/Decoder Encode and decode JWT tokens with signature verification
Base64 Encoder/Decoder Convert text and binary data to/from Base64

API-Backed Tools

These tools require server-side processing:

Tool Description
Social Card Preview Extract OpenGraph and Twitter Card metadata from URLs
QR Code Generator Create scannable QR codes
Barcode Generator Generate Code128 and other standard barcodes
Steganography Hide and extract messages within images using LSB technique

Planned Features

  • URL Shortener
  • JSON Formatter
  • Diff Viewer
  • Timestamp Converter
  • Color Tools
  • Password Generator
  • Fake Data Generator
  • Text Case Converter

Quick Start

Using Docker Compose

# Start both services
docker-compose up

# Start individual services
docker-compose up api
docker-compose up ui

Access the application:

  • UI: http://localhost:8001
  • API: http://localhost:8000
  • API Health: http://localhost:8000/

Documentation

For detailed information about each component:

License

MIT License - see LICENSE file for details.

Contributing

The project is designed to be modular and extensible. New utilities can be added as:

  • Client-side tools in ui/src/components/apps/
  • API services in api/src/services/

Each tool should be self-contained and follow the existing patterns for consistency.