Skip to content

chaxus/ran

Repository files navigation

πŸš€ Ran - Technology Exploration & Learning Platform

ran logo

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

license PRs welcome! Build Status Types Included forks stars

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 ranui version npm-d web component library
ranuts ranuts version npm-d Utility library

Experimental Projects

Package Description
im Chat application prototype
ml Machine learning experiments
visual Data visualization experiments
solidity Web3 smart contract experiments
ranite Development tooling experiments
debug Debug utilities
image-process Image processing 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

⚠️ 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

Contributors

πŸ“„ License

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


Made with ❀️ by the Ran community

If this project helps you learn, please give it a ⭐️