Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 2.67 KB

README.md

File metadata and controls

74 lines (49 loc) · 2.67 KB

Doma UI

License: MIT Build Status

Doma UI is an open-source component library designed to streamline your development process by offering a collection of customizable and reusable UI components. Built using React, TailwindCSS, Framer, and Storybook, Doma UI aims to enhance the efficiency and aesthetics of your web applications.

✨ Features

  • Modular Components: A variety of ready-to-use UI components that can be easily integrated into your React projects.
  • Customizable: Leverage the power of TailwindCSS to quickly customize the appearance and behavior of components to fit your design needs.
  • Framer Motion: Seamless integration of animations and transitions, powered by Framer.
  • Storybook Integration: Explore, test, and document your components in isolation using Storybook.
  • Responsive Design: Built with mobile-first design principles to ensure components look great on any screen size.

📦 Installation

To install Doma UI in your project, run:

npm install doma-ui

Or if you're using yarn:

yarn add doma-ui

🚀 Usage

To use a component from Doma UI, simply import it into your project and start building!

import { Button } from "doma-ui";

function App() {
	return (
		<div className="App">
			<Button variant="primary">Click Me</Button>
		</div>
	);
}

📚 Documentation

For detailed documentation on each component, please refer to the Storybook documentation.

🤝 Contributing

Contributions are welcome! If you have an idea for a new component or improvements to existing ones, feel free to fork the repository and submit a pull request. Please make sure to follow the contributing guidelines.

🛠️ Roadmap

  • Add more basic components (e.g., Input, Modal, Tooltip)
  • Improve component documentation with more examples and use cases
  • Expand animation presets using Framer Motion
  • Add dark mode support

📄 License

Doma UI is licensed under the MIT License. See the LICENSE file for more details.

🙏 Acknowledgements

📫 Contact

For any inquiries or support, you can reach out via email or connect with me on LinkedIn.