Skip to content

README.md

Latest commit

 

History

History
64 lines (37 loc) · 1.9 KB

README.md

File metadata and controls

64 lines (37 loc) · 1.9 KB

Petit Kit 🛠️

A collection of lightweight, modular JavaScript utilities designed for modern web development. Built with TypeScript, tree-shakable, and framework-agnostic.

🎯 Philosophy

Petit Kit follows the Unix philosophy: "Do one thing and do it well". Each package is focused, lightweight, and can be used independently or together to build powerful web applications.

📦 Packages

@petit-kit/scope 🎭

Web Components framework with props, lifecycle hooks, and plugins

@petit-kit/template 🎨

Lightweight virtual DOM and templating system

@petit-kit/magasin 🏪

Lightweight state management with reactive subscriptions

@petit-kit/scroll 📜

Smooth scrolling with plugins for advanced scroll effects

@petit-kit/utils 🔧

Essential utility functions for common web development tasks

🏗️ Architecture

Each package is designed to be:

  • Modular: Use only what you need
  • Tree-shakable: Unused code is eliminated during bundling
  • TypeScript-first: Full type safety and IntelliSense
  • Framework-agnostic: Works with any framework or vanilla JS
  • Lightweight: Minimal bundle size impact
  • Performant: Optimized for modern browsers

🤝 Contributing

We welcome contributions! Feel free to clone and do PRs.

📄 License

MIT License

👨‍💻 Author

@petitssoldats - [email protected] - nicolasforestier.dev

⭐ Support

If you find this project helpful, please consider:

  • ⭐ Starring the repository
  • 🐛 Reporting bugs
  • 💡 Suggesting new features
  • 🤝 Contributing code

Petit Kit - Small tools, big possibilities! 🚀