Skip to content
This repository has been archived by the owner on Jul 28, 2024. It is now read-only.

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Chaoyingz committed Mar 4, 2024
1 parent f80cde5 commit 0f05a8e
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 22 deletions.
29 changes: 12 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@
<a href="https://flect.celerforge.com/"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/Chaoyingz/flect/blob/main/README_CN.md">简体中文</a>
·
<a href="https://github.com/Chaoyingz/flect/issues">Report Bug</a>
·
<a href="https://github.com/Chaoyingz/flect/issues">Request Feature</a>
·
<a href="https://github.com/Chaoyingz/flect/blob/main/README_CN.md">简体中文</a>
</p>
</div>

Expand All @@ -35,22 +35,10 @@ The key features are:

- **Fast development**: Write your entire app with Python, seamlessly integrating backend logic and frontend UI.
- **Easy Form Validation**: Define a single Pydantic model for seamless and consistent form validation across your app, enhancing development speed and reducing potential errors.
- **Client-Side Routing**: Fast, smooth page transitions without reloads.
- **Folder-Based Routing**: Easy route management through folder structure.
- **Client-Side Routing**: Fast, smooth page transitions without reloads.
- **SEO Friendly**: Supports server-side rendering for better search engine visibility.

## Requirements

- Python 3.9+

## Installation

```console
$ pip install flect

---> 100%
```

## Example

In this example, we will demonstrate how to build a simple to-do application using flect. As flect is built on top of [FastAPI](https://fastapi.tiangolo.com/), so you can define your routes using FastAPI’s syntax.
Expand Down Expand Up @@ -136,9 +124,16 @@ async def post(form: TodoInCreate) -> ActionResponse:
Which renders like this:
![flect-todo](https://github.com/Chaoyingz/flect/assets/32626585/f48415d8-b25c-432d-8dc4-d0bd4d65777d)

## Demo
## Learn More

- [Documentation](https://flect.celerforge.com/)

## Credits

This project draws inspiration from the following frameworks:

Check out the `docs` folder in the project repository. The documentation website is built directly from these sources.
- [FastUI](https://github.com/pydantic/FastUI)
- [Next.js](https://nextjs.org/)

## License

Expand Down
17 changes: 12 additions & 5 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
<a href="https://flect.celerforge.com/"><strong>探索文档 »</strong></a>
<br />
<br />
<a href="https://github.com/Chaoyingz/flect/">English</a>
·
<a href="https://github.com/Chaoyingz/flect/issues">报告错误</a>
·
<a href="https://github.com/Chaoyingz/flect/issues">请求新功能</a>
·
<a href="https://github.com/Chaoyingz/flect/">English</a>
</p>
</div>

Expand All @@ -28,8 +28,8 @@ flect 是一个用于构建全栈 Web 应用程序的 Python 框架。它通过

- **快速开发**:使用 Python 编写整个应用,无缝集成后端逻辑和前端 UI。
- **简单的表单验证**:定义单一的 Pydantic 模型,实现整个应用中的无缝且一致的表单验证,提高开发速度,减少潜在错误。
- **客户端路由**:无需重新加载即可实现快速、流畅的页面转换。
- **基于文件夹的路由**:通过文件夹结构轻松管理路由。
- **客户端路由**:无需重新加载即可实现快速、流畅的页面转换。
- **SEO 友好**:支持服务器端渲染,以获得更好的搜索引擎可见性。

## 系统要求
Expand Down Expand Up @@ -129,9 +129,16 @@ async def post(form: TodoInCreate) -> ActionResponse:
渲染出来的效果如下:
![flect-todo](https://github.com/Chaoyingz/flect/assets/32626585/f48415d8-b25c-432d-8dc4-d0bd4d65777d)

## 演示
## 了解更多

- [文档](https://flect.celerforge.com/)

## 鸣谢

本项目受到以下框架的启发:

请查看项目仓库中的 `docs` 文件夹。文档网站直接从这些源文件构建。
- [FastUI](https://github.com/pydantic/FastUI)
- [Next.js](https://nextjs.org/)

## 证书

Expand Down

0 comments on commit 0f05a8e

Please sign in to comment.