Skip to content

Latest commit

 

History

History
104 lines (76 loc) · 5.26 KB

README.md

File metadata and controls

104 lines (76 loc) · 5.26 KB

Avati Logo

CI Release CodeQL codecov Commitizen friendly

Welcome to Avati — a thoughtfully crafted toolkit designed to empower developers in building and shipping high-quality UI widgets and packages with ease. The mission is to provide tools and libraries that follow the best practices, ensuring a smooth development experience while maintaining top-tier code quality.

⚠️ Warning: Project in Development

Avati is currently in the development phase. While many tools are functional, the project is under active development and subject to changes. Expect frequent updates and improvements as I refine the tools and add new features.

I appreciate your understanding and patience during this phase. If you encounter any issues or have suggestions, your feedback is invaluable in shaping Avati.

Vision

Avati is built with a clear focus on:

  • Developer Productivity: Accelerate your development workflow with pre-built, customizable utilities.
  • High Standards: Adhere to industry best practices for maintainable, scalable, and efficient code.
  • Comprehensive Coverage: From animation and state management to event handling and logging, Avati covers a wide spectrum of UI development needs.

I believe in enabling developers to focus more on innovation and less on reinventing the wheel.

Project Progress

Here’s what I am currently working on:

Completed

  • Animation utilities (animation)
  • Debouncing and throttling tools (debounce, throttle)
  • Event listener management (listener)
  • State management (state)
  • Basic logger (logger)

In Progress

  • [⌛] Advanced logger with customizable transports (logger)
  • [⌛] Improved scroll management (scrollable)
  • [⌛] React like UI library (html)
  • [⌛] Cli and templates scaffolding (avati-create-lib)
  • [⌛] Pointer events toolkit (pointer)
  • [⌛] Improve demo and examples quality
  • [⌛] Signals Documentation and publish to npm

DEV Ops and other

  • [⌛] Add more tests cases
  • [⌛] Website
  • [⌛] publish to npm
  • [⌛] CI/CD
  • [⌛] Documentation

Upcoming

  • Element toolkit (element)
  • CSS utility helpers (css)
  • Accessibility enhancements for UI widgets (a11y)

🚀 Features

Maintenance TypeScript Code Style Conventional Commits

  • 🔥 High Performance: Optimized for speed and efficiency
  • 📦 Tree Shakeable: Only import what you need
  • 🔒 Type Safe: Written in TypeScript with full type coverage
  • 📚 Well Documented: Comprehensive API documentation
  • ⚡️ Lightweight: Minimal bundle size impact
  • 🧪 Well Tested: Extensive test coverage
  • 🔄 Framework Agnostic: Use with any framework

Contributing

I welcome contributions from developers of all experience levels. If you have an idea, found a bug, or want to improve something, I encourage you to get involved!

How to Contribute

  1. Read Contributing Guide for details on how to get started.
  2. Fork the repository and make your changes.
  3. Submit a pull request, and we’ll review it as soon as possible.

📝 License

MIT License

Avati is open-source and distributed under the MIT License.


Follow on Twitter Follow on LinkedIn Follow on Medium Made with ❤️ Star on GitHub Follow on GitHub