🚀 Ran - Exploration & Learning

A monorepo for technology exploration and learning, featuring experimental UI libraries, utilities, and various tools.

Features • Packages • Quick Start • Documentation • Contributing

---

English · 中文

✨ Features

• 🎨 UI Libraries: web components
• 🛠️ Utility Libraries: TypeScript utilities
• 🤖 Machine Learning: Basic ML tools and experiments
• 📱 Web Applications: IM chat app (prototype)
• 🔧 Development Tools: Build tools and debug utilities
• 🌐 Web3: Smart contract experiments
• 🎯 Visual Tools: Data visualization experiments

📦 Packages

This monorepo contains various experimental packages:

Core Libraries (Alpha Stage)

Package	Version	Downloads	Description
ranui			web component library
ranuts			Utility library

Experimental Projects

Package	Description
im	Chat application prototype
visual	Data visualization experiments
ranite	Development tooling experiments
debug	Debug utilities
image-process	Image processing experiments
cpro	C/C++ learning & experiments
rust	Rust learning & experiments

🚀 Quick Start

Installation

# Clone the repository
git clone https://github.com/chaxus/ran.git
cd ran

# Install dependencies
pnpm install

# Build all packages
pnpm build

Using Core Packages

# Install ranui (web components)
npm install ranui

# Install utilities
npm install ranuts

Development

# Start development server
pnpm dev

# Run tests
pnpm test

# Build specific package
pnpm --filter ranui build

📚 Documentation

• 📖 Blog & Articles: Design Patterns & More
• 🎨 RanUI Documentation: UI Library Guide
• 🛠️ RanUTS Documentation: Utility Library Guide
• 📝 Project Documentation: docs

🤖 AI / Claude Code

This repo ships a Claude Code plugin marketplace so AI assistants can read and use the libraries without spelunking the source. Add the marketplace, then install whichever library you use:

/plugin marketplace add chaxus/ran
/plugin install ranui@ran      # ranui — web components
/plugin install ranuts@ran     # ranuts — utilities

Each skill covers the import map, an inventory, usage examples, and conventions, and points to the API reference shipped in that package. See the per-library sections in ranui and ranuts.

⚠️ Important Notice

This is a technology exploration and learning project in early development. Most packages are in alpha stage or experimental phase.

Key points:

• 🚧 Early Development: Most features are still being developed
• 🧪 Experimental: APIs may change frequently
• 📚 Learning Focus: Primarily for learning and experimentation

🤝 Contributing

We welcome contributions from learners and developers! Here's how you can help:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Development Guidelines

• Follow the existing code style
• Add tests for new features when possible
• Update documentation as needed
• Be patient with experimental features

🌟 Why Open Source?

I believe in the power of open source to accelerate learning and innovation. Throughout my development journey, I've been greatly influenced by countless open-source projects. By open-sourcing this experimental code, I hope to:

• Share learning experiences with the community
• Enable others to learn from and experiment with this code
• Foster collaboration and knowledge sharing
• Create a platform for continuous learning and improvement

📊 Project Stats

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

---