coderio 0.1.2-alpha.1 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +13 -5
  2. package/dist/cli.js +1 -1
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -6,7 +6,7 @@ AI-Powered Design-to-Code Tool with High-Fidelity UI Restoration
6
6
 
7
7
  [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE) [![Node Version](https://img.shields.io/badge/node-%3E%3D18.0.0%20%3C23.0.0-brightgreen)](https://nodejs.org/) [![npm version](https://img.shields.io/npm/v/coderio.svg)](https://www.npmjs.com/package/coderio) [![Contributors](https://img.shields.io/github/contributors/MigoXLab/coderio)](https://github.com/MigoXLab/coderio/graphs/contributors)
8
8
 
9
- đŸ’Ŧ Contact: [WeChat Group](https://aicarrier.feishu.cn/docx/KTZCddG2VoarFExTqBEcS55QnRd) | <a href="mailto:coderio&#64;pjlab&#46;org&#46;cn">Email</a>
9
+ đŸ’Ŧ Contact: <a href="https://aicarrier.feishu.cn/docx/KTZCddG2VoarFExTqBEcS55QnRd" target="_blank">WeChat Group</a> | <a href="mailto:coderio&#64;pjlab&#46;org&#46;cn">Email</a>
10
10
 
11
11
  [English](README.md) | [įŽ€äŊ“中文](README_zh-CN.md)
12
12
 
@@ -32,7 +32,7 @@ AI-Powered Design-to-Code Tool with High-Fidelity UI Restoration
32
32
 
33
33
  CodeRio is an intelligent **Figma-to-Code** automation tool that transforms designs into production-ready React code. Unlike traditional converters, CodeRio employs a multi-agent system that validates visual accuracy and iteratively refines misalignments, pursuing high-fidelity UI restoration and **production-ready code structure tailored for developers**.
34
34
 
35
- ![How CodeRio works](./docs/framework.gif)
35
+ https://github.com/user-attachments/assets/a0bc1b1c-6aaa-4fbb-a2d8-18aeba70759b
36
36
 
37
37
  **Perfect for:**
38
38
 
@@ -42,11 +42,19 @@ CodeRio is an intelligent **Figma-to-Code** automation tool that transforms desi
42
42
 
43
43
  ## ✨ Examples
44
44
 
45
- ### Case: Landing Page (CLI with --mode full)
45
+ ### Case: CLI with --mode full
46
46
 
47
- This example demonstrates a landing page converted from Figma. It includes a header, main content area, and footer, showcasing CodeRio's ability to handle complex layouts and component structures.
47
+ After installing CodeRio, you can execute commands directly in the CLI. CodeRio excels at restoring complex landing page styles, handling intricate layouts, identifying and downloading diverse image resources, and encapsulating component structures. By selecting "FULL" mode, a visual fidelity evaluation report is generated upon completion. This report displays deviations between the design and the webpage using both annotation and overlay modes, providing effective guidance for further development by engineers. This example demonstrates a landing page converted from Figma ([Design Link](https://www.figma.com/design/c0UBII8lURfxZIY8W6tSDR/Top-16-Websites-of-2024---Awwwards--Community-?node-id=1-1482&t=FB3Hohq2nsH7ZFts-4)).
48
48
 
49
- [View Validation Report](https://htmlpreview.github.io/?https://github.com/MigoXLab/coderio/blob/main/examples/case1/report.html)
49
+ https://github.com/user-attachments/assets/bd0c3f18-e98a-4050-bf22-46b198fadac2
50
+
51
+ <a href="https://static.openxlab.org.cn/coderio/report.html" target="_blank">📊 View Interactive Validation Report</a>
52
+
53
+ ### Case: Development with Cursor Skill
54
+
55
+ CodeRio can be seamlessly integrated into Cursor as a Skill. Simply input a prompt like **"Create a React project and restore this design with high fidelity,"** along with your output directory, Figma URL([Design Link](https://www.figma.com/design/c0UBII8lURfxZIY8W6tSDR/Top-16-Websites-of-2024---Awwwards--Community-?node-id=30-8264&t=FB3Hohq2nsH7ZFts-4)), and Token. The Agent will guide you step-by-step through the page generation process. For Landing Pages, it achieves **high-fidelity restoration**, accurately reproducing images and styles. It also automatically encapsulates reusable components (such as cards) and strictly adheres to **frontend development best practices**.
56
+
57
+ https://github.com/user-attachments/assets/a66dc680-f68d-4121-b416-aa6b778bd895
50
58
 
51
59
  ## 🚀 Quick Start
52
60
 
package/dist/cli.js CHANGED
@@ -475,7 +475,7 @@ var AGENT_CONTEXT_WINDOW_TOKENS = 128e3;
475
475
 
476
476
  // src/cli/init.ts
477
477
  function registerCommands(program) {
478
- const version = false ? "0.0.1" : "0.1.2-alpha.1";
478
+ const version = false ? "0.0.1" : "1.0.0";
479
479
  program.name(CLI_NAME).description(`${CLI_NAME} - Convert Figma designs to code`).version(version, "-v, -V, --version", "Output the version number").showHelpAfterError();
480
480
  }
481
481
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "coderio",
3
- "version": "0.1.2-alpha.1",
3
+ "version": "1.0.0",
4
4
  "description": "A modern CLI development tool built with TypeScript",
5
5
  "type": "module",
6
6
  "bin": {