Skip to content

UnSetSoft/Ryunixjs

Repository files navigation

RyunixJS Logo

RyunixJS

npm version canary version license Ask DeepWiki

A powerful, standalone, and high-performance JavaScript framework for building modern web applications.


🚀 What is RyunixJS?

RyunixJS is a modern UI framework designed to be completely standalone. While it draws inspiration from popular libraries like React and Preact, it doesn't include them internally. It provides a familiar API (Hooks, Components) but follows its own path to allow for a more manageable and moldable development experience.

Whether you're building a simple static site or a complex Single Page Application (SPA) with Server-Side Rendering (SSR), RyunixJS gives you the tools to do it efficiently.

✨ Key Features

  • 🎯 Zero Dependencies: The core library is lightweight and independent.
  • ⚛️ Familiar API: Use useStore, useEffect, useContext, and more. While similar to React, Ryunix provides its own specialized hooks.
  • 🌐 Hybrid Rendering: Built-in support for SSR (Server-Side Rendering) and SSG (Static Site Generation).
  • 🔋 Server-Side Power: Supports Server Components and Server Actions for modern full-stack workflows.
  • 📝 Native MDX: Write documentation or content-rich pages directly in MDX with seamless integration.
  • 📦 Specialized Hooks: Includes powerful built-ins like usePersistentStore (auto-sync with localStorage), useSwitch (toggle state), useDebounce, useThrottle, and more.
  • 🛠️ Integrated Tooling: Powerful presets and a dedicated CLI to get you started in seconds.
  • 🔍 DevTools: A dedicated browser extension to debug your Ryunix applications.

📦 Packages

RyunixJS is managed as a monorepo containing several specialized packages:

Package Description
@unsetsoft/ryunixjs The core library containing the reconciler, hooks, and DOM utilities.
@unsetsoft/ryunix-presets Unified tooling and Webpack configurations for different environments.
@unsetsoft/cra The Official CLI to scaffold new Ryunix projects effortlessly.
@unsetsoft/ryunix-devtools Browser extension for debugging and inspecting component trees.

🛠️ Getting Started

The quickest way to start a new project is using our CLI:

npx @unsetsoft/cra@latest my-ryunix-app

Navigate to your app and start the development server:

cd my-ryunix-app
npm run dev

🤝 Contributing

We love contributions! If you have ideas, bug reports, or want to add a new feature, please follow these steps:

  1. Check Issues: See if there's already an existing issue or create a new one to propose your change.
  2. Branching Strategy:
    • Create a branch named gh/[user]/[feature-name].
    • All changes should target the canary branch first.
  3. Commit Messages: Keep them simple and descriptive.
  4. Version Management: Do not manually change package versions; this is handled during the release process.

Check out our Contributing Guide (if available) for more details.

📄 License

RyunixJS is MIT Licensed.


Built with ❤️ by UnSetSoft

About

A modular JavaScript UI framework powered by a custom reconciliation engine and a robust Webpack build system for high-performance SSR and static site generation

Topics

Resources

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

 

Packages

 
 
 

Contributors