Monolith

Monolith

Next-generation color barcode system with 50x data density
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Monolith is revolutionizing how we store and transfer data in the physical world. By leveraging layered hexagonal color patterns, we've created a barcode system that can store up to 50x more data than traditional QR codes while being significantly more resilient to damage.

Key Features:

• 📦 High Data Density: Store up to 50x more data than traditional barcodes
• 🛡️ Damage Resistant: Maintains readability even with 30% physical damage
• 🎨 Color Innovation: Uses RGB/CMYK layers for enhanced data capacity
• 🔄 Format Flexibility: Supports text, URLs, binary data, and more
• 📱 Universal Scanning: Works with any RGB/CMYK-capable scanner

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• Rust

  curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Installation

1. Clone the repo

   git clone https://github.com/jbirbal-skydom/monolith.git
   cd monolith
   git submodule init
   git submodule update

2. Build the project

   cargo build --release

3. Run tests

   cargo test

Monolith System Repositories

Why multi-binary approach I chose a multi-binary approach split into distinct security domains. This decision stems from several security and operational considerations. By separating the system into multiple binaries, we create natural security boundaries between different components, following the principle of least privilege. The core cryptographic operations can run in a separate process from the networking stack, and the audit logging system can operate independently.

monolith

The main meta-repository that brings together all Monolith components. This repository uses Git submodules to manage the individual components and provides a unified build system for the entire Monolith ecosystem.

• Purpose: Project coordination, system-wide documentation, and integrated builds
• Dependencies: All other repositories as submodules
• Key Features: Workspace management, CI/CD pipelines, system-wide testing

monolith-common

Shared library containing common utilities, types, and interfaces used across all Monolith components.

• Purpose: Code reuse, standardization, and interface definitions
• Key Features: Crypto primitives, common traits, shared types, communication protocols
• Used By: All other Monolith components

monolith-gui

The graphical user interface component for the Monolith system.

• Purpose: User interaction and data visualization
• Dependencies: monolith-common
• Key Features: Color pattern visualization, code generation interface, scanning interface

monolith-core

Core processing and coordination component of the Monolith system.

• Purpose: Central coordination and main business logic
• Dependencies: monolith-common
• Key Features: Request handling, component coordination, main processing pipeline

monolith-data-process

Data processing and analysis component.

• Purpose: Handle data transformation and processing
• Dependencies: monolith-common
• Key Features: Data validation, transformation, pattern recognition

monolith-generator

Code generation and pattern creation component.

• Purpose: Generate Monolith codes and patterns
• Dependencies: monolith-common
• Key Features: Pattern generation, code optimization, error correction

monolith-output

Output handling and export component.

• Purpose: Handle final code output and export
• Dependencies: monolith-common
• Key Features: Output formatting, file export, printing preparation

monolith-key-mgmt

Security and key management component.

• Purpose: Handle all cryptographic operations and key management
• Dependencies: monolith-common
• Key Features: Ephemeral key generation, key distribution, signature verification

(back to top)

Usage

Basic Example

use monolith::encoder;

let data = "Hello, Monolith!";
let code = encoder::generate(data, Options::default());
code.save("my_code.png")?;

Scanning

use monolith::decoder;

let code = decoder::scan_from_image("code.png")?;
println!("Decoded data: {}", code.data());

For more examples and usage, please refer to the Documentation

(back to top)

Roadmap

• Core encoding/decoding engine
• Basic RGB/CMYK support
• Error correction implementation
• Mobile SDK
  • iOS Framework
  • Android Library
• Web Components
• Enterprise Features

See the open issues for a full list of proposed features and known issues.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/jbirbal-skydom/monolith

(back to top)

Acknowledgments

• OpenCV Community
• Rust Community
• All Contributors
• Sponsors

(back to top)