Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/praveenjuge/kutty
Kutty is a tailwind plugin for building web applications. It has a set of accessible and reusable components that are commonly used in web applications.
https://github.com/praveenjuge/kutty
alpinejs tailwind tailwind-plugin tailwindcss tailwindcss-plugin
Last synced: 1 day ago
JSON representation
Kutty is a tailwind plugin for building web applications. It has a set of accessible and reusable components that are commonly used in web applications.
- Host: GitHub
- URL: https://github.com/praveenjuge/kutty
- Owner: praveenjuge
- License: mit
- Created: 2020-05-18T05:17:31.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-09-13T13:44:05.000Z (about 1 year ago)
- Last Synced: 2024-05-02T23:47:18.174Z (5 months ago)
- Topics: alpinejs, tailwind, tailwind-plugin, tailwindcss, tailwindcss-plugin
- Language: JavaScript
- Homepage: https://kutty.netlify.app
- Size: 2.66 MB
- Stars: 795
- Watchers: 13
- Forks: 44
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kutty
Kutty is a tailwind plugin for building web applications. It has a set of accessible and reusable components that are commonly used in web applications.
---
### Also see [mynaui.com](https://mynaui.com)
- [x] TailwindCSS UI Components and Templates made without any Plugin.
- [x] Open Source.
- [x] Fully Responsive and Accessible.
---
## Installation
```sh
npm install kutty --save
```
This plugin requires Tailwind CSS 3 or later. Tailwind CSS is not included in this package. Learn how to [install tailwind here](https://tailwindcss.com/docs/installation/).
## Usage
### For CSS
Require the installed plugin directly to your Tailwind config:
```js
// tailwind.config.js
plugins: [require("kutty")],
```
### For JS
We bundle AlpineJS v2.8.0 for reactivity in our components. Learn more about [AlpineJS here](https://github.com/alpinejs/alpine). Place the following script tag before the closing body tag.
```html
```
```html
```
## Documentation
View full documentation at [https://kutty.netlify.app](https://kutty.netlify.app).
## Bugs & Suggestions
Found a bug? [Please open a new issue](https://github.com/praveenjuge/kutty/issues/new). Use [GitHub Discussions](https://github.com/praveenjuge/kutty/discussions) for new feature requests.
## Development
You need [Hugo](https://gohugo.io/) to run the dev server. If you have [Homebrew](https://brew.sh/) you can do the following:
```sh
brew install hugo
```
Check this [Hugo installation page](https://gohugo.io/getting-started/installing/) for installing on other systems.
Then clone the repo, install dependencies, and start the server locally.
```sh
git clone https://github.com/praveenjuge/kutty.git
cd kutty
npm install
npm start
```
Open [`http://localhost:1313`](http://localhost:1313) in your browser.
| Scripts | Description |
| -------------------- | ----------------------------------------------- |
| `npm start` | Starts a local Hugo server and Tailwind Watcher |
| `npm run production` | For generating production docs files |
## License
See the [LICENSE](https://github.com/praveenjuge/kutty/blob/master/LICENSE) file.