From e3890972496866ae519861140a182d8cc0737983 Mon Sep 17 00:00:00 2001 From: "Gerasimos (Makis) Maropoulos" Date: Sun, 31 Dec 2017 07:22:31 +0200 Subject: [PATCH] add(?) the chinese readme, some sentences are from the previous translation by community and the rest.... let's hope someone will help us more here Former-commit-id: bd5fbd2ee29389f609793148845c658f08722297 --- CONTRIBUTING.md | 1 + HISTORY.md | 9 ++ README.md | 2 +- README_ZH.md | 222 +++++++++++++++++++++++++++++++++++++++ learn.jpg.REMOVED.git-id | 1 - 5 files changed, 233 insertions(+), 2 deletions(-) create mode 100644 README_ZH.md delete mode 100644 learn.jpg.REMOVED.git-id diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b2bac024..dbcda5e0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -47,6 +47,7 @@ Instructions can be found at: https://github.com/kataras/iris/issues/796 Write an article about Iris in https://medium.com , https://dev.to or if you're being a hackathon at https://hackernoon.com, some examples: +* [A Hasura starter project with a ready to deploy Golang hello-world web app with IRIS](bit.ly/2lmKaAZ) * [Top 6 web frameworks for Go as of 2017](https://blog.usejournal.com/top-6-web-frameworks-for-go-as-of-2017-23270e059c4b) * [Iris Go Framework + MongoDB](https://medium.com/go-language/iris-go-framework-mongodb-552e349eab9c) * [How to build a file upload form using DropzoneJS and Go](https://hackernoon.com/how-to-build-a-file-upload-form-using-dropzonejs-and-go-8fb9f258a991) diff --git a/HISTORY.md b/HISTORY.md index 2331ca17..16c39980 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -171,6 +171,15 @@ func(ctx iris.Context) { Item's name: {{.Name}} ``` +## context#YAML + +Add a new `context#YAML` function, it renders a yaml from a structured value. + +```go +// YAML marshals the "v" using the yaml marshaler and renders its result to the client. +func YAML(v interface{}) (int, error) +``` + ## Session#GetString `sessions/session#GetString` can now return a filled value even if the stored value is a type of integer, just like the memstore, the context's temp store, the context's path parameters and the context's url parameters. \ No newline at end of file diff --git a/README.md b/README.md index fefdd2a3..95c170ae 100644 --- a/README.md +++ b/README.md @@ -163,7 +163,7 @@ First of all, the most correct way to begin with a web framework is to learn the - Navigate through **100+1** **[examples](_examples)** and some [iris starter kits](#iris-starter-kits) we crafted for you - Read the [godocs](https://godoc.org/github.com/kataras/iris) for any details -- Prepare a cup of coffee or tea, whatever pleasures you the most, and read some [articles](#articles) we found for you +- Prepare a cup of coffee or tea, whatever pleases you the most, and read some [articles](#articles) we found for you ### Iris starter kits diff --git a/README_ZH.md b/README_ZH.md new file mode 100644 index 00000000..91a5d87c --- /dev/null +++ b/README_ZH.md @@ -0,0 +1,222 @@ +# Iris Web Framework + + + +[![build status](https://img.shields.io/travis/kataras/iris/master.svg?style=flat-square)](https://travis-ci.org/kataras/iris) [![report card](https://img.shields.io/badge/report%20card-a%2B-ff3333.svg?style=flat-square)](http://goreportcard.com/report/kataras/iris) [![chat](https://img.shields.io/badge/community-%20chat-00BCD4.svg?style=flat-square)](https://kataras.rocket.chat/channel/iris) [![view examples](https://img.shields.io/badge/learn%20by-examples-0077b3.svg?style=flat-square)](_examples/) [![release](https://img.shields.io/badge/release%20-v10.0-0077b3.svg?style=flat-square)](https://github.com/kataras/iris/releases) + +Iris是一个超快、简单并且高效的Go语言Web开发框架。 + +Iris功能很强大，使用又很简单，它将会是你下一个网站、API服务或者分布式应用基础框架的不二之选。 + +看看[别人是如何评价Iris](#support)，同时欢迎各位[成为Iris星探](https://github.com/kataras/iris/stargazers)，或者关注[Iris facebook主页](https://facebook.com/iris.framework)。 + +## Backers + +感谢所有的支持者! [成为一个支持者](https://opencollective.com/iris#backer) + + + +```sh +$ cat example.go +``` + +```go +package main + +import "github.com/kataras/iris" + +func main() { + app := iris.New() + // 从"./views"目录加载HTML模板 + // 模板解析html后缀文件 + // 此方式是用`html/template`标准包(Iris的模板引擎) + app.RegisterView(iris.HTML("./views", ".html")) + + // HTTP方法： GET + // 路径： http://localhost:8080 + app.Get("/", func(ctx iris.Context) { + // {{.message}} 和 "Hello world!" 字串绑定 + ctx.ViewData("message", "Hello world!") + // 映射HTML模板文件路径 ./views/hello.html + ctx.View("hello.html") + }) + + // HTTP方法: GET + // 路径: http://localhost:8080/user/42 + // + // 想在路径中用正则吗？ + // 如下所示 + // app.Get("/user/{id:string regexp(^[0-9]+$)}") + app.Get("/user/{id:long}", func(ctx iris.Context) { + userID, _ := ctx.Params().GetInt64("id") + ctx.Writef("User ID: %d", userID) + }) + + // 绑定端口并启动服务. + app.Run(iris.Addr(":8080")) +} +``` + +> 想要了解更多关于路径参数配置，戳[这里](_examples/routing/dynamic-path/main.go#L31)。 + +```html + + + + Hello Page + + +

{{.message}}

+ + +``` + +```sh +$ go run example.go +Now listening on: http://localhost:8080 +Application Started. Press CTRL+C to shut down. +_ +``` + +## 安装 + +唯一的要求是 [Go Programming Language](https://golang.org/dl/) + +```sh +$ go get -u github.com/kataras/iris +``` + +Iris使用[vendor](https://docs.google.com/document/d/1Bz5-UB7g2uPBdOx-rw5t9MxJwkfpx90cqG9AFL0JAYo) 包依赖管理方式。vendor包管理的方式可以有效处理包依赖更新问题 + +[![Iris vs .NET Core(C#) vs Node.js (Express)](https://iris-go.com/images/benchmark-new-gray.png)](_benchmarks/README_UNIX.md) + +_更新于: [2017年11月21日星期二](_benchmarks/README_UNIX.md)_ + +
+来自第三方来源的其他网络框架的基准 + +![Comparison with other frameworks](https://raw.githubusercontent.com/smallnest/go-web-framework-benchmark/4db507a22c964c9bc9774c5b31afdc199a0fe8b7/benchmark.png) + +
+ +## 支持 + +- [HISTORY](HISTORY.md#mo-01-jenuary-2018--v1000)文件是您最好的朋友，它包含有关最新功能和更改的信息 +- 你碰巧找到了一个错误？ 张贴在 [github issues](https://github.com/kataras/iris/issues) +- 您是否有任何疑问或需要与有经验的人士交谈以实时解决问题？ [加入我们的聊天](https://chat.iris-go.com) +- [点击这里完成我们基于表单的用户体验报告](https://docs.google.com/forms/d/e/1FAIpQLSdCxZXPANg_xHWil4kVAdhmh7EBBHQZ_4_xSZVDL-oCC_z5pA/viewform?usp=sf_link) +- 你喜欢这个框架吗？ Tweet关于它的一些事情！ 人民已经说了: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ +[如何贡献代码](CONTRIBUTING.md) 文件。 + +[贡献者列表](https://github.com/kataras/iris/graphs/contributors) + +## 学习 + +首先，从Web框架开始的最正确的方法是学习编程语言和标准的`http`功能的基础知识，如果您的web应用程序是一个非常简单的个人项目，没有性能和可维护性要求，您可能想要 只需使用标准软件包即可。 之后，遵循指导原则: + +- 浏览 **100+1** **[例子](_examples)** 和一[些入门套件](#iris-starter-kits) 我们为你制作 +- 阅读 [godocs](https://godoc.org/github.com/kataras/iris) 任何细节 +- 准备一杯咖啡或茶，无论你喜欢什么，并阅读我们为你找到的一[些文章](#articles) + +### Iris starter kits + + + +1. [A basic web app built in Iris for Go](https://github.com/gauravtiwari/go_iris_app) +2. [A mini social-network created with the awesome Iris💖💖](https://github.com/iris-contrib/Iris-Mini-Social-Network) +3. [Iris isomorphic react/hot reloadable/redux/css-modules starter kit](https://github.com/iris-contrib/iris-starter-kit) +4. [Demo project with react using typescript and Iris](https://github.com/ionutvilie/react-ts) +5. [Self-hosted Localization Management Platform built with Iris and Angular](https://github.com/iris-contrib/parrot) +6. [Iris + Docker and Kubernetes](https://github.com/iris-contrib/cloud-native-go) +7. [Quickstart for Iris with Nanobox](https://guides.nanobox.io/golang/iris/from-scratch) +8. [A Hasura starter project with a ready to deploy Golang hello-world web app with IRIS](https://hasura.io/hub/project/hasura/hello-golang-iris) + +> 你有类似的东西吗？ [让我们知道](https://github.com/kataras/iris/pulls)! + +### Middleware + +Iris拥有大量的处理程序[[1]](middleware/)[[2]](https://github.com/iris-contrib/middleware)，可以与您的Web应用程序并排使用。 不过，您并不局限于此 - 您可以自由使用与[net/http](https://golang.org/pkg/net/http/)软件包兼容的任何第三方中间件，[_examples/convert-handlers](_examples/convert-handlers) 将向您显示方式。 + +### 用品 + +* [A Hasura starter project with a ready to deploy Golang hello-world web app with IRIS](bit.ly/2lmKaAZ) +* [Top 6 web frameworks for Go as of 2017](https://blog.usejournal.com/top-6-web-frameworks-for-go-as-of-2017-23270e059c4b) +* [Iris Go Framework + MongoDB](https://medium.com/go-language/iris-go-framework-mongodb-552e349eab9c) +* [How to build a file upload form using DropzoneJS and Go](https://hackernoon.com/how-to-build-a-file-upload-form-using-dropzonejs-and-go-8fb9f258a991) +* [How to display existing files on server using DropzoneJS and Go](https://hackernoon.com/how-to-display-existing-files-on-server-using-dropzonejs-and-go-53e24b57ba19) +* [Iris, a modular web framework](https://medium.com/@corebreaker/iris-web-cd684b4685c7) +* [Go vs .NET Core in terms of HTTP performance](https://medium.com/@kataras/go-vs-net-core-in-terms-of-http-performance-7535a61b67b8) +* [Iris Go vs .NET Core Kestrel in terms of HTTP performance](https://hackernoon.com/iris-go-vs-net-core-kestrel-in-terms-of-http-performance-806195dc93d5) +* [How to Turn an Android Device into a Web Server](https://twitter.com/ThePracticalDev/status/892022594031017988) +* [Deploying a Iris Golang app in hasura](https://medium.com/@HasuraHQ/deploy-an-iris-golang-app-with-backend-apis-in-minutes-25a559bf530b) +* [A URL Shortener Service using Go, Iris and Bolt](https://medium.com/@kataras/a-url-shortener-service-using-go-iris-and-bolt-4182f0b00ae7) + +### 受雇用 + +有很多公司和初创公司寻找具有虹膜经验的Go网站开发者，我们每天都在寻找你，我们通过[facebook page](https://www.facebook.com/iris.framework)发布这些信息，就像页面得到通知一样，我们已经发布了一些信息。 + +### 赞助商 + +感谢所有赞助商! (请通过成为赞助商来请求贵公司支持这个开源项目) + + + + +## 执照 + +Iris is licensed under the [3-Clause BSD License](LICENSE). 虹膜是100％免费和开源软件。 + +有关许可证的任何问题，[请发送电子邮件](mailto:kataras2006@hotmail.com?subject=Iris%20License)。 diff --git a/learn.jpg.REMOVED.git-id b/learn.jpg.REMOVED.git-id deleted file mode 100644 index 48fe3cda..00000000 --- a/learn.jpg.REMOVED.git-id +++ /dev/null @@ -1 +0,0 @@ -efa10f1e68d7042b7340b8db37c38e18e351bc3f \ No newline at end of file