瀏覽代碼

Add Simplified Chinese version of the README (#1341)

Steven Yu 1 年之前
父節點
當前提交
391135e235
共有 3 個文件被更改,包括 242 次插入2 次删除
  1. 1 1
      README.md
  2. 240 0
      docs/zh/zh_cn/README.md
  3. 1 1
      docs/zh/zh_tw/README.md

+ 1 - 1
README.md

@@ -23,7 +23,7 @@
 
 ---
 
-[English](README.md) | [繁體中文](/docs/zh/zh_tw/README.md)
+[English](README.md) | [简体中文](/docs/zh/zh_cn/README.md) | [繁體中文](/docs/zh/zh_tw/README.md)
 
 ---
 

+ 240 - 0
docs/zh/zh_cn/README.md

@@ -0,0 +1,240 @@
+<div align="center">
+
+<img src="../../images/cones.png">
+<hr>
+
+**✨ 使用 Python 创建高效且可自订的网页应用程序,几秒钟内即可部署。**
+
+📑 [Docs](https://pynecone.io/docs/getting-started/introduction) &nbsp; 📱 [Component Library](https://pynecone.io/docs/library) &nbsp; 🖼️ [Gallery](https://pynecone.io/docs/gallery) &nbsp; 🛸 [Deployment](https://pynecone.io/docs/hosting/deploy)
+
+[![PyPI version](https://badge.fury.io/py/reflex.svg)](https://badge.fury.io/py/reflex)
+![tests](https://github.com/pynecone-io/pynecone/actions/workflows/build.yml/badge.svg)
+![versions](https://img.shields.io/pypi/pyversions/reflex-dev.svg)
+[![Discord](https://img.shields.io/discord/1029853095527727165?color=%237289da&label=Discord)](https://discord.gg/T5WSbC2YtQ)
+
+</div>
+
+### 不同语言的 README
+
+---
+
+[English](../../../README.md) | [简体中文](README.md) | [繁体中文](../zh_tw/README.md)
+
+---
+
+## 📦 1. 安装
+
+Reflex 需要以下最低要求:
+
+-   Python 3.7+
+-   [Node.js 16.8.0+](https://nodejs.org/en/) (不用担心,你不需要写任何 JavaScript!)
+
+```
+pip install reflex
+```
+
+## 🥳 2. 创建你的第一个应用程序
+
+安装 Reflex 的同时也会安装 `rx` 命令行工具. 通过创建一个新项目来测试是否安装成功。
+
+把 my_app_name 替代为你的项目名字:
+
+```
+mkdir my_app_name
+cd my_app_name
+reflex init
+```
+
+当你第一次运行这个命令,将会自动下载与安装 [bun](https://bun.sh/)。
+
+这个命令会初始化一个应用程序模板在一个新的文件夹。
+
+## 🏃 3. 运行
+
+你可以在开发者模式运行这个应用程序:
+
+```
+reflex run
+```
+
+你可以看到你的应用程序运行在 http://localhost:3000。
+
+现在在以下位置修改原代码 `my_app_name/my_app_name.py`,Reflex 拥有快速重整所以你可以在保存代码后马上看到更改。
+
+## 🫧 范例
+
+让我们来看一个例子: 创建一个使用 DALL·E 的图形用户接口,为了保持范例简单,我们只使用 OpenAI API,但是你可以将其替换成本地端的 ML 模型。
+
+&nbsp;
+
+<div align="center">
+<img src="../images/dalle.gif" alt="A frontend wrapper for DALL·E, shown in the process of generating an image." width="550" />
+</div>
+
+&nbsp;
+
+这是上述范例的完整代码,只需要一个 Python 文件就可以完成!
+
+```python
+import reflex as rx
+import openai
+
+openai.api_key = "YOUR_API_KEY"
+
+class State(rx.State):
+    """应用程序状态"""
+    prompt = ""
+    image_url = ""
+    image_processing = False
+    image_made = False
+
+    def process_image(self):
+        """设置图片处理旗标为 True 并设置还未产生图片"""
+        self.image_processing = True
+        self.image_made = False
+
+    def get_image(self):
+        """运用 prompt 取得的参数产生图片"""
+        response = openai.Image.create(prompt=self.prompt, n=1, size="1024x1024")
+        self.image_url = response["data"][0]["url"]
+        self.image_processing = False
+        self.image_made = True
+
+def index():
+    return rx.center(
+        rx.vstack(
+            rx.heading("DALL·E", font_size="1.5em"),
+            rx.input(placeholder="Enter a prompt..", on_blur=State.set_prompt),
+            rx.button(
+                "产生图片",
+                on_click=[State.process_image, State.get_image],
+                width="100%",
+            ),
+            rx.divider(),
+            rx.cond(
+                State.image_processing,
+                rx.circular_progress(is_indeterminate=True),
+                rx.cond(
+                     State.image_made,
+                     rx.image(
+                         src=State.image_url,
+                         height="25em",
+                         width="25em",
+                    )
+                )
+            ),
+            bg="white",
+            padding="2em",
+            shadow="lg",
+            border_radius="lg",
+        ),
+        width="100%",
+        height="100vh",
+        bg="radial-gradient(circle at 22% 11%,rgba(62, 180, 137,.20),hsla(0,0%,100%,0) 19%)",
+    )
+
+# 把状态跟页面添加到应用程序。
+app = rx.App(state=State)
+app.add_page(index, title="Reflex:DALL·E")
+app.compile()
+```
+
+### **Reflex 中的图形用户接口**
+
+让我们分解以上步骤。
+
+```python
+def index():
+    return rx.center(
+        ...
+    )
+```
+
+这个 `index` function 定义了应用程序的前端.
+
+我们用不同的组件像是 `center`, `vstack`, `input`, 和 `button` 来创建前端, 组件之间可以相互嵌入,来创建复杂的布局。
+并且你可以使用关键字参数来使用 CSS 的全部功能。
+
+Reflex 拥有 [60+ built-in components](https://pynecone.io/docs/library) 来帮助你开始创建应用程序。
+我们正在积极添加组件, 但是你也可以简单的自己创建一些组件 [create your own components](https://pynecone.io/docs/advanced-guide/wrapping-react)。
+
+### **状态**
+
+Reflex 用 State 来渲染你的 UI。
+
+```python
+class State(rx.State):
+    """应用程序状态"""
+    prompt = ""
+    image_url = ""
+    image_processing = False
+    image_made = False
+```
+
+State 定义了应用程序中所有可以更改的变量及变更他们的 function (称为 vars)。
+
+这里的状态由 `prompt` 和 `image_url`组成, 以及布尔变量 `image_processing` 和 `image_made` 来决定何时显示进度条及图片。
+
+### **事件处理进程**
+
+```python
+    def process_image(self):
+        """设置图片处理旗标为 True 并设置还未产生图片"""
+        self.image_processing = True
+        self.image_made = False
+
+    def get_image(self):
+        """运用 prompt 取得的参数产生图片"""
+        response = openai.Image.create(prompt=self.prompt, n=1, size="1024x1024")
+        self.image_url = response["data"][0]["url"]
+        self.image_processing = False
+        self.image_made = True
+```
+
+在 State 中我们定义了事件处理进程来更改状态变量,事件处理进程是我们在 Reflex 中修改状态的方法,可以使用它们来回应用户操作,像是点击按钮或在文本框输入这些动作都是一种事件。
+
+我们的 DALL·E. 应用程序有两个事件处理进程 `process_image` 表示正在生成图片和 `get_image` 调用 OpenAI API。
+
+### **路由**
+
+最后定义我们的应用程序并发送状态给它。
+
+```python
+app = rx.App(state=State)
+```
+
+添加从应用程序根目录到 index 组件的路由。 我们也添加了一个标题将会显示在 预览/浏览 分页。
+
+```python
+app.add_page(index, title="Reflex:DALL-E")
+app.compile()
+```
+
+你可以借由通过添加路由来增加更多页面。
+
+## Reflex 状态
+
+Reflex 于 2022 年 12 月推出。
+
+截至 2023 年 3 月,我们处于 **Public Beta** 阶段。
+
+-   :white_check_mark: **Public Alpha**: 任何人都可以安装与使用 Reflex,或许包含问题, 但我们正在积极的解决他们。
+-   :large_orange_diamond: **Public Beta**: 对于非软件产品来说足够稳定。
+-   **Public Hosting Beta**: _Optionally_, 部属跟托管你的 Reflex!
+-   **Public**: 这版本的 Reflex 是可用于软件产品的。
+
+Reflex 每周都有新功能和发布新版本! 确保你按下 :star: 和 :eyes: watch 这个 repository 来确保知道最新信息。
+
+## 贡献
+
+我们欢迎任何大小的贡献,以下是几个好的方法来加入 Reflex 社群。
+
+-   **加入我们的 Discord**: 我们的 [Discord](https://discord.gg/T5WSbC2YtQ) 是帮助你加入 Reflex 项目和讨论或贡献最棒的地方。
+-   **GitHub Discussions**: 一个来讨论你想要添加的功能或是需要澄清的事情的好地方。
+-   **GitHub Issues**: 报告错误的绝佳地方,另外你可以试着解决一些 issue 和送出 PR。
+
+我们正在积极寻找贡献者,无关你的技能或经验水平。
+
+## 授权
+
+Reflex 是一个开源项目且使用 [Apache License 2.0](LICENSE) 授权。

+ 1 - 1
docs/zh/zh_tw/README.md

@@ -18,7 +18,7 @@
 
 ---
 
-[English](../../../README.md) | [繁體中文](README.md)
+[English](../../../README.md) | [简体中文](../zh_cn/README.md) | [繁體中文](README.md)
 
 ---