pirulug / pirulug-bootstrap-5-ui-kit Goto Github PK

View Code? Open in Web Editor NEW

PiruUI is a set of UI components and utilities built on top of Bootstrap 5, designed to help create modern, responsive user interfaces. This kit is perfect for designers and developers looking for a solid, customizable foundation for their web projects.

License: MIT License

JavaScript 41.32% SCSS 19.65% CSS 1.46% Pug 37.56%

pirulug-bootstrap-5-ui-kit's Introduction

PiruUI - Bootstrap 5 UI Kit

Demo

Features

Compatibility: Based on Bootstrap 5, ensuring compatibility and support with most modern browsers.
Custom Components: Includes a series of custom components and extensions that enhance Bootstrap's functionality.
Easy to Use: Ready to use in your projects with no additional configuration required.
Customizable: Easily modify and extend the kit to fit the needs of your project.
Themes: Supports light and dark themes, with the possibility to extend to more themes.

Installation

To use PiruUI in your project, you can clone this repository or download the necessary files.

Clone the Repository

git clone https://github.com/pirulug/piruui-bootstrap-5-ui-kit.git

Usage

After cloning or downloading the files, simply include the CSS and JS resources in your project: html Copiar código

<link rel="stylesheet" href="dist/css/app.css"> 
<script src="dist/js/app.js"></script>

Basic Example

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>PiruUI Example</title>
    <link rel="stylesheet" href="dist/css/app.css">
</head>
<body>
    <div class="container">
        <h1 class="text-center">Welcome to PiruUI</h1>
        <button class="btn btn-primary">Primary Button</button>
    </div>
    <script src="dist/js/app.js"></script>
</body>
</html>

Development

If you want to contribute or modify PiruUI, follow these steps to set up the development environment:

Requirements

Node.js
npm or yarn

Install Dependencies

npm install

Build Files

npm run build

This will generate the minified CSS and JS files in the dist folder.

Live Development

To see changes in real-time, you can use the following command:

npm start

Contributing

Contributions are welcome. If you find any issues or have suggestions, please open an issue or submit a pull request.

License

This project is licensed under the MIT License. You can see more details in the LICENSE file.

Author

Developed by Pirulug.

Recommend Projects