Skip to content

Commit cc5ee1e

Browse files
committed
update readme
1 parent 6409f44 commit cc5ee1e

File tree

1 file changed

+30
-23
lines changed

1 file changed

+30
-23
lines changed

README.md

Lines changed: 30 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,43 @@
1-
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
1+
## 🚀 Design-to-Code Automation Toolkit
22

3-
## Getting Started
3+
This project is a fully free, semi-automated **UX-to-UI delivery pipeline**, built to streamline the journey from Figma design to production-ready React components. It integrates **Figma Tokens**, **Figma API**, **Tailwind CSS**, **CVA**, and **AI-powered generation** — all wrapped with **GitHub Actions** and **Chromatic** for continuous UI testing.
44

5-
First, run the development server:
5+
### ✨ Key Features
66

7-
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
15-
```
7+
- 🧠 **Token Extraction**
8+
Sync design decisions from Figma Tokens Studio and convert them into Tailwind-compatible utility classes.
169

17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
10+
- 🔍 **Figma Node Mapping**
11+
Fetch raw component metadata from Figma API and intelligently map it to corresponding token rules.
1812

19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
13+
- ⚙️ **AI-Driven Component Generator**
14+
Use structured prompts to automatically scaffold `class-variance-authority` based React components.
2015

21-
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
16+
- 📘 **AI-Generated Documentation**
17+
Storybook `.stories.tsx` files are auto-created for every generated component, ready for designer-developer handoff.
2218

23-
## Learn More
19+
-**CI & Visual Testing**
20+
Every `git push` triggers GitHub Actions and Chromatic, providing automated UI validation and snapshot review.
2421

25-
To learn more about Next.js, take a look at the following resources:
22+
### 📦 Tech Stack
2623

27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
24+
- Figma Tokens Studio (Free)
25+
- Figma REST API
26+
- Tailwind CSS
27+
- CVA (Class Variance Authority)
28+
- OpenAI / Claude Prompt Workflows
29+
- Storybook
30+
- GitHub Actions
31+
- Chromatic (Free plan)
2932

30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
33+
### 📈 Value
3134

32-
## Deploy on Vercel
35+
This project demonstrates how to:
3336

34-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
37+
- Bridge design and engineering workflows under real-world tool limitations
38+
- Apply AI to reduce UI handoff cost while maintaining structure and consistency
39+
- Integrate CI into design systems for continuous visual testing
3540

36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
41+
---
42+
43+
> 💡 This toolkit is ideal for frontend engineers, design system maintainers, or teams seeking to prototype automated design-to-code workflows without relying on paid SaaS tools.

0 commit comments

Comments
 (0)