boreui
v1.0.0
Published
A modern, reusable React component library built with TypeScript.
Maintainers
Readme
🧱 BoreUI
BoreUI is a fast, reusable, and developer-first React UI component library built for performance, consistency, and beautiful interfaces. Designed to help you ship faster, maintain better, and scale with confidence.
✨ Features
- ⚛️ Built with React and modern ES modules
- 🎨 Pre-styled components using Tailwind CSS
- 🧩 Fully tree-shakeable and modular
- ♻️ Easy to extend and theme
- 📦 Ready for NPM, Yarn, pnpm
- 📖 Designed for documentation, playgrounds, and design systems
📦 Installation
npm install boreui
# or
yarn add boreui
# or
pnpm add boreui
Note: Make sure you have react and tailwindcss set up in your project.
🔥 Quick Start
// App.jsx
import { Button } from 'boreui';
function App() {
return (
<div className="p-4">
<Button variant="ghost">Ghost Button</Button>
</div>
);
}
export default App;
🧰 Available Components
Button
Input
Card
Badge
Modal
Avatar
...more coming soon
🧠 Philosophy
“Design is not just what it looks like and feels like. Design is how it works.” — Steve Jobs
BoreUI embraces the practical and the aesthetic. It’s a component system forged in real-world use cases: fast, elegant, and developer-centric. No bloat. Just the essentials.
📁 Folder Structure
boreui/
├── src/
│ ├── components/
│ ├── utils/
│ └── index.ts
├── dist/
├── package.json
├── tsconfig.json
└── README.md
📚 Documentation
Coming soon at boreui.dev (not live yet)
🛠️ Development
Clone this repo and run:
=> pnpm install
=> pnpm dev
Build for production:
=> pnpm build
🤝 Contributing
BoreUI is open to contributions! Help us improve it:
Fork the repository
Create your feature branch (git checkout -b feat/new-component)
Commit your changes
Push to the branch
Open a Pull Request
📄 License
MIT © Forkan Hossen Shanto
💬 Feedback
Have ideas? Found a bug? Open an issue or email us at [email protected].