Skip to content

Latest commit

 

History

History
174 lines (129 loc) · 6.12 KB

README.md

File metadata and controls

174 lines (129 loc) · 6.12 KB

Love Simple UI

weekly download minzip weekly download license GitHub issues

GitHub forks

💻Tech Stack

typescript javascript NodeJS css css StoryBook mdx

🤔 What is Love-Simple-UI

love-simple-ui is an open-source, lightweight, and highly customizable UI library with integrated Tailwind CSS, designed to provide an attractive and efficient user interface for web applications.

Features

  • Lightweight: love-simple-ui is designed to be lightweight, ensuring fast loading times and optimal performance for your web applications.

  • Customizable: With love-simple-ui, you have the freedom to customize every aspect of your user interface to match your desired style and branding. Tailwind CSS integration makes it even easier to tweak the UI to your liking.

  • Beautiful Design: The UI components provided by love-simple-ui are thoughtfully designed to be visually appealing and user-friendly, ensuring a delightful user experience.

  • Responsive: love-simple-ui is built with responsiveness in mind, ensuring that your web application looks great on any device or screen size.

  • Easy to Use: The library is designed to be beginner-friendly, allowing developers to quickly and effortlessly integrate it into their projects. The intuitive API and well-documented code make it easy to get started.

  • Comprehensive Documentation: love-simple-ui comes with comprehensive documentation that guides you through the installation process and provides detailed examples and usage instructions for each component.

📦️ Installation

To install love-simple-ui via npm, follow these steps:

  • Open a terminal window and navigate to your project directory
  • Run the following command:
    npm install love-simple-ui # Wait for the installation to complete.
  • If you want to add it as a development dependency
    npm install love-simple-ui --save-dev
  • Alternatively, you can add love-simple-ui as a dependency to your project by including it in your package.json file.
    npm install love-simple-ui --save

🛠️ Usage

To use love-simple-ui in your project, you must first import the library into your project. To do this, add the following line to the top of your JavaScript file:

import { component } from "love-simple-ui";

Once you've imported the library, you can use any of the components it contains. For example, to use the PrimaryButton component, simply add the following line to your code:

import { Buttton1 } from "love-simple-ui";

function App() {
  return (
    <div className="App">
      <Button1>Hello World!</Button1>
    </div>
  );
}

😍 Contributing

Contributions are welcomed! If you'd like to contribute to love-simple-ui, please follow these steps:

  • Fork this repository

  • First clone the forked repository to your local System:
git clone <repository Url or ssh>
  • Create a new branch:
git checkout -b <branch_name>
  • Make your changes and commit them:
git commit -m '<commit_message>'
  • Push to the original branch:
git push origin love-simple-ui/<location>
  • Create the pull request from Pull request tab

Alternatively, you can create a new issue if you find a bug or have a feature request.

License

Licensed under the MIT License.

Contributors

(Back to top)