tweakcn README

The project's README from github.com/jnsahaj/tweakcn. As one markdown file: README.md.

tweakcn.com

Vercel OSS Program

Discord GitHub Repo stars X (formerly Twitter) URL

tweakcn is a powerful Visual Theme Editor for tailwind CSS & shadcn/ui components. It comes with Beautiful theme presets to get started, while aiming to offer advanced customisation for each aspect of your UI

tweakcn.com

Motivation

Websites made with shadcn/ui famously look the same. tweakcn is a tool that helps you customize shadcn/ui components visually, to make your components stand-out. The goal is to build a platform where a user can discover endless customization options and then have the ability to put their own twist on it.

Current Features

You can find the full feature list here: https://tweakcn.com/#features

Run Locally

IMPORTANT: For contributions, please see CONTRIBUTING.md.

Prerequisites

Installation

  1. Clone the repository:
git clone https://github.com/jnsahaj/tweakcn.git
cd tweakcn
  1. Install dependencies:
npm install
  1. Start the development server:
npm run dev
  1. Open http://localhost:3000 in your browser.

Contributors

Made with contrib.rocks.

Interested in Contributing?

Contributions are welcome! Please feel free to submit a Pull Request.

Star History

GitHub Star History for jnsahaj/tweakcn

tweakcn (jnsahaj/tweakcn)

Searching Database…

10.5K ·GitHub
What is this?tweakcn is a visual no-code theme editor for Tailwind CSS and shadcn/ui components — you restyle your UI through a graphical editor instead of hand-writing theme code, starting from ready-made presets.
Is it a website I use in the browser or a library I install?It's a web app: the hosted version lives at tweakcn.com, and you can also run the app yourself locally. What you take into your own project is the theme it produces, not the editor itself.
How do I run it locally?You need Node.js 18+ and npm, yarn or pnpm. Clone the repo, install dependencies, start the dev server and open it in your browser — it's a Next.js app, so that's npm run dev.
Is it only useful if my project already uses shadcn/ui?Essentially yes — it's built to theme shadcn/ui components styled with Tailwind CSS, so it assumes your project is on that stack. For anything else there's nothing for it to edit.
Why did the author build this?Because websites made with shadcn/ui famously look the same. The goal is a platform where you can discover endless customization options and then put your own twist on them.
Does it ship ready-made themes, or do I design everything myself?It comes with beautiful theme presets to get started, while still aiming to offer advanced customization for each aspect of your UI.
Is there anything AI-powered under the hood?The dependency list includes Google AI SDKs (@ai-sdk/google and @google/generative-ai), so the app hooks into Google AI — though the README itself doesn't describe what those AI features do.
Creator
jnsahaj
Size
89.4 MB
Stars
10.5K
Updated
CommitSep 03
Age
1y
Commits · 90 Days