atakantepe / tailwind-cheat-sheet

A user-friendly Tailwind CSS cheat sheet built with React and Vite.
https://www.atakantepe.com/tailwind-cheat-sheet/
4 stars 1 forks source link
cheat-sheet frontend react tailwind-css tailwindcss vite web-development

Tailwind Cheat Sheet

Welcome to the Tailwind CSS Cheat Sheet! This project aims to provide a user-friendly Tailwind CSS cheat sheet using React and Vite.

Version 0.1.0

You can view the live version at atakantepe.com/tailwind-cheat-sheet.

Tailwind CSS Parser

This project utilizes the Tailwind CSS Parser that I built. The parser helps in extracting and organizing Tailwind CSS classes for easy reference.

Getting Started

To run the project locally, follow these steps:

  1. Clone the repository

    git clone https://github.com/atakantepe/tailwind-cheat-sheet.git
    cd tailwind-cheat-sheet
  2. Install dependencies

    npm install
  3. Run the development server

    npm run dev

    Your development server should now be running at http://localhost:3000.

Contributing

Contributions are welcome! Here’s how you can contribute:

  1. Fork the repository: Click the "Fork" button at the top of this page.

  2. Clone your fork:

    git clone https://github.com/your-username/tailwind-cheat-sheet.git
    cd tailwind-cheat-sheet
  3. Create a branch:

    git checkout -b feature/YourFeatureName
  4. Make your changes: Implement your feature or fix.

  5. Commit your changes:

    git add .
    git commit -m 'Add some feature'
  6. Push to the branch:

    git push origin feature/YourFeatureName
  7. Open a Pull Request: Navigate to your fork on GitHub and click the "New Pull Request" button.

Issues

If you encounter any issues or have suggestions for improvements, please open an issue on GitHub.