Skip to content

Latest commit

 

History

History
77 lines (51 loc) · 3.73 KB

README.md

File metadata and controls

77 lines (51 loc) · 3.73 KB

Tailwind You

Tailwindcss and Material You design with the logic covered

A frontend UI Component framework supporting most of the major frontend UI frameworks including React, Vue.

Tailwind You includes a variety of HTML, Vue React components, all created with Tailwind CSS classes and following Material You Design principles.

Tailwind You is tailwindcss based. It gives the full power to styling. Also creating unique styles in tailwind you is unbelievably easy using global StyleObjects. Giving full power to modifying the style of the components in any state. Also because its tailwindcss based thus gives out of the box modularity

Project structure

name description
@tailwind-you/react react components
@tailwind-you/vue vue components
@tailwind-you/styles default style objects
@tailwind-you/tailwindcss-preset-tailwind-you framework specific tailwindcss configuration
@tailwind-you/types cross framework component specific props & style-object type declarations

Installation

Make sure Nodejs v12+, tailwindcss is installed & configured React:

$ npm i @tailwind-you/react @tailwind-you/styles && npm i -D @tailwind-you/tailwindcss-preset-tailwind-you

using yarn

$ yarn add @tailwind-you/react @tailwind-you/styles && yarn add -D @tailwind-you/tailwindcss-preset-tailwind-you

Vue:

$ npm i @tailwind-you/vue @tailwind-you/styles && npm i -D @tailwind-you/tailwindcss-preset-tailwind-you

using yarn

$ yarn add @tailwind-you/vue @tailwind-you/styles && yarn add -D @tailwind-you/tailwindcss-preset-tailwind-you

Docs

Docs are located in tailwind-you-sooty.vercel.app. Visit it to learn more about tailwind you

Contribution

Contributors needed! Any kind contribution related to this project & following all the instructions/rules defined in CONTRIBUTION.md are warmly accepted

Currently this projects needs your support. We need some reactjs, vuejs developers who can willingly contribute to this Open-Source project

Running locally

Make sure you have nodejs@^12 & npm@^7 installed. Then git clone the repository & in the project root directory run:

$ npm install

To run the React project:

$ cd ./packages/react/ && npm start 

To run the Vue project:

$ cd ./packages/vue/ && npm start 

This will start the storybook dev-server & will show the link where it got served