A modern React component library for building consistent, composable UIs. Built with Tailwind CSS and designed for rapid development.
- ✨ Beautiful and accessible components
- ⚙️ Easy customization via Tailwind
- 🧩 Composable and reusable hooks, services, and stores
- 📚 Documentation & Storybook integration
npm install compositlyor
yarn add compositlyimport 'compositly/public/output.css' // Tailwind styles
import {
// components
ComponentBase,
// helpers
// hooks
// services
// stores
} from 'compositly'
export default function App() {
return <ComponentBase id='hello-world' />
}📘 For our website, viti compositly.com 📘 For full documentation, visit docs.compositly.com
npm installnpm run devnpm run cior
yarn cipublic/output.css after changes. Tailwind can generate many unused classes.
| Script | Description |
|---|---|
dev |
Starts the development server |
css |
Builds the CSS |
css:dev |
Builds CSS in watch/dev mode |
test |
Runs tests with coverage |
lint |
Runs ESLint |
lint:fix |
Fixes lint errors |
format |
Formats code using Prettier |
build |
Builds for production |
preview |
Previews the production build locally |
ci |
Runs tests, lint, and formatting |
stories |
Starts the Storybook server |
stories:build |
Builds the Storybook site |
docs |
Starts the documentation server |
docs:build |
Builds the documentation for production |
clean |
Cleans dist, node_modules, package-lock.json, etc. |
- Components – Prebuilt UI elements (e.g.
Button,Modal,Card) - Hooks – Custom hooks for common logic
- Services – API or utility functions
- Stores – Zustand-based global stores
- Helpers – Pure utility functions
We welcome contributions! Please read our contributing guide and follow the code style defined in .eslintrc.
Coverage is generated in .coverage/index.html, and you can view it in your browser. To generate coverage, run:
yarn testThis is an example of the coverage report:
If you find Compositly helpful and want to support its development, you can make a donation — every bit helps us build faster and better!
🔗 Donate here: https://compositly.com/donate
You can donate using crypto or traditional payment platforms. Thank you for your support! 💙
For questions, feedback, or business inquiries:
✉️ Email: netzuleando@gmail.com
🌐 Website: https://compositly.com
Made with ❤️ by the Compositly Team